JScience v2.0

org.jscience.physics.quantities
Class Dimensionless

java.lang.Object
  extended by javolution.realtime.RealtimeObject
      extended by org.jscience.mathematics.numbers.Number<Quantity>
          extended by org.jscience.physics.quantities.Quantity
              extended by org.jscience.physics.quantities.Dimensionless
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Quantity>, Realtime, Operable<Quantity>, Numeric<Quantity>
Direct Known Subclasses:
Angle, DataAmount, SolidAngle

public class Dimensionless
extends Quantity

This class represents a dimensionless quantity. It contains methods for performing basic numeric operations such as the elementary exponential, logarithm and trigonometric functions.

Version:
1.0, October 24, 2004
Author:
Jean-Marie Dautelle
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.jscience.physics.quantities.Quantity
Quantity.Factory<Q extends Quantity>
 
Nested classes/interfaces inherited from interface javolution.realtime.Realtime
Realtime.ObjectSpace
 
Field Summary
static Dimensionless e
          Holds the natural logarithmic base.
static Dimensionless ONE
          Represents a Dimensionless amounting to 1.
static Dimensionless ZERO
          Represents a Dimensionless amounting to nothing.
 
Constructor Summary
protected Dimensionless()
          Default constructor (allows for derivation).
 
Method Summary
 Angle acos()
          Returns an Angle such as its cosine is this Dimensionless.
 Angle asin()
          Returns an Angle such as its sine is this Dimensionless.
 Angle atan()
          Returns an Angle such as its tangent is this Dimensionless.
 Dimensionless exp()
          Returns the exponential number e raised to the power of this Dimensionless.
 Dimensionless log()
          Returns the natural logarithm (base e) of this Dimensionless.
 Dimensionless pow(Dimensionless exp)
          Returns this Dimensionless raised to the power of the specified Dimensionless exponent.
static void showAs(Unit unit)
          Shows Dimensionless instances in the specified unit.
static Dimensionless valueOf(double doubleValue)
          Returns the dimensionless corresponding to the specified doubleValue
 
Methods inherited from class org.jscience.physics.quantities.Quantity
approxEquals, compareTo, divide, doubleValue, equals, getAbsoluteError, getAmount, getMaximum, getMinimum, getRelativeError, getUnit, hashCode, isLargerThan, longValue, minus, norm, opposite, plus, rangeOf, reciprocal, root, sqrt, times, times, to, toText, valueOf, valueOf, valueOf
 
Methods inherited from class org.jscience.mathematics.numbers.Number
abs, byteValue, divide, floatValue, intValue, inverse, isGreaterThan, isLessThan, pow, shortValue
 
Methods inherited from class javolution.realtime.RealtimeObject
export, move, moveHeap, preserve, recycle, toString, unpreserve
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javolution.realtime.Realtime
move
 

Field Detail

ZERO

public static final Dimensionless ZERO
Represents a Dimensionless amounting to nothing.


ONE

public static final Dimensionless ONE
Represents a Dimensionless amounting to 1.


e

public static final Dimensionless e
Holds the natural logarithmic base.

Constructor Detail

Dimensionless

protected Dimensionless()
Default constructor (allows for derivation).

Method Detail

valueOf

public static Dimensionless valueOf(double doubleValue)
Returns the dimensionless corresponding to the specified doubleValue

Parameters:
doubleValue - the double value.

showAs

public static void showAs(Unit unit)
Shows Dimensionless instances in the specified unit.

Parameters:
unit - the display unit for Dimensionless instances.

exp

public Dimensionless exp()
Returns the exponential number e raised to the power of this Dimensionless.

Returns:
exp(this)

log

public Dimensionless log()
Returns the natural logarithm (base e) of this Dimensionless.

Returns:
log(this)

pow

public Dimensionless pow(Dimensionless exp)
Returns this Dimensionless raised to the power of the specified Dimensionless exponent.

Parameters:
exp - the exponent.
Returns:
this**exp

asin

public Angle asin()
Returns an Angle such as its sine is this Dimensionless.

Returns:
the arc sine of this angle.

acos

public Angle acos()
Returns an Angle such as its cosine is this Dimensionless.

Returns:
the arc cosine of this angle.

atan

public Angle atan()
Returns an Angle such as its tangent is this Dimensionless.

Returns:
the arc tangent of this angle

JScience v2.0

Copyright © 2005 JScience.