DoubleScalar.Rel (DJUNITS 1.02.01 API)

java.lang.Object
- java.lang.Number
- - org.djunits.value.Scalar
 - - org.djunits.value.vdouble.scalar.DoubleScalar
 - - org.djunits.value.vdouble.scalar.DoubleScalar.Rel

Type Parameters:

U - Unit

All Implemented Interfaces:

Serializable, Comparable<DoubleScalar.Rel>, MathFunctions<DoubleScalar>, Relative, Value, DoubleMathFunctions<DoubleScalar>

Direct Known Subclasses:

Acceleration, AnglePlane.Rel, AngleSlope.Rel, AngleSolid, Area, Density, Dimensionless.Rel, ElectricalCharge, ElectricalCurrent, ElectricalPotential, ElectricalResistance, Energy, FlowMass, FlowVolume, Force, Frequency, Length.Rel, LinearDensity, Mass, Money, MoneyPerArea, MoneyPerEnergy, MoneyPerLength, MoneyPerMass, MoneyPerTime, MoneyPerVolume, Power, Pressure, Speed, Temperature.Rel, Time.Rel, Torque, Volume

Enclosing class:

DoubleScalar>
```
public static class DoubleScalar.Rel>
extends DoubleScalar
implements Relative, Comparable<DoubleScalar.Rel>
```
See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.djunits.value.vdouble.scalar.DoubleScalar
 DoubleScalar.Abs>, DoubleScalar.Rel>

Field Summary

Fields
Modifier and Type Field and Description

double si
The value, stored in the standard SI unit.

Fields
Modifier and Type	Field and Description
`double`	`si` The value, stored in the standard SI unit.

Constructor Summary

Constructors
Constructor and Description
`Rel(DoubleScalar.Rel<U> value)` Construct a new Relative Immutable DoubleScalar from an existing Relative Immutable DoubleScalar.
`Rel(double value, U unit)` Construct a new Relative Immutable DoubleScalar.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DoubleScalar.Rel<U>`	`abs()` Set the value(s) to their absolute value.
`DoubleScalar.Rel<U>`	`acos()` Set the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.
`DoubleScalar.Rel<U>`	`asin()` Set the value(s) to the arc sine of the value(s); the resulting angle is in the range -pi/2 through pi/2.
`DoubleScalar.Rel<U>`	`atan()` Set the value(s) to the arc tangent of the value(s); the resulting angle is in the range -pi/2 through pi/2.
`DoubleScalar.Rel<U>`	`cbrt()` Set the value(s) to the(ir) cube root.
`DoubleScalar.Rel<U>`	`ceil()` Set the value(s) to the smallest (closest to negative infinity) value(s) that are greater than or equal to the argument and equal to a mathematical integer.
`int`	`compareTo(DoubleScalar.Rel<U> o)`
`DoubleScalar.Rel<U>`	`cos()` Set the value(s) to the trigonometric cosine of the value(s).
`DoubleScalar.Rel<U>`	`cosh()` Set the value(s) to the hyperbolic cosine of the value(s).
`DoubleScalar.Rel<U>`	`divideBy(double constant)` Scale the value(s) by the inverse of a factor; i.e.
`boolean`	`eq(DoubleScalar.Rel<U> o)` Test if this DoubleScalar.Rel<U> is equal to a DoubleScalar.Rel<U>.
`DoubleScalar.Rel<U>`	`exp()` Set the value(s) to Euler's number e raised to the power of the value(s).
`DoubleScalar.Rel<U>`	`expm1()` Set the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).
`DoubleScalar.Rel<U>`	`floor()` Set the value(s) to the largest (closest to positive infinity) value(s) that are less than or equal to the argument and equal to a mathematical integer.
`boolean`	`ge(DoubleScalar.Rel<U> o)` Test if this DoubleScalar.Rel<U> is greater than a DoubleScalar.Rel<U>.
`double`	`getSI()` Retrieve the value in the underlying SI unit.
`boolean`	`gt(DoubleScalar.Rel<U> o)` Test if this DoubleScalar.Rel<U> is greater than or equal to a DoubleScalar.Rel<U>.
`DoubleScalar.Rel<U>`	`inv()` Set the value(s) to the complement (1.0/x) of the value(s).
`boolean`	`le(DoubleScalar.Rel<U> o)` Test if this DoubleScalar.Rel<U> is less than or equal to a DoubleScalar.Rel<U>.
`DoubleScalar.Rel<U>`	`log()` Set the value(s) to the natural logarithm (base e) of the value(s).
`DoubleScalar.Rel<U>`	`log10()` Set the value(s) to the base 10 logarithm of the value(s).
`DoubleScalar.Rel<U>`	`log1p()` Set the value(s) to the natural logarithm of the sum of the value(s) and 1.
`boolean`	`lt(DoubleScalar.Rel<U> o)` Test if this DoubleScalar.Rel<U> is less than a DoubleScalar.Rel<U>.
`DoubleScalar.Rel<U>`	`minus(DoubleScalar.Rel<U> decrement)` Decrement the value by the supplied value and return the result.
`DoubleScalar.Rel<U>`	`multiplyBy(double constant)` Scale the value(s) by a factor.
`boolean`	`ne(DoubleScalar.Rel<U> o)` Test if this DoubleScalar.Rel<U> is not equal to a DoubleScalar.Rel<U>.
`DoubleScalar.Rel<U>`	`plus(DoubleScalar.Rel<U> increment)` Increment the value by the supplied value and return the result.
`DoubleScalar.Rel<U>`	`pow(double x)` Set the value(s) to the value(s) raised to the power of the argument.
`DoubleScalar.Rel<U>`	`rint()` Set the value(s) to the value(s) that are closest in value to the argument and equal to a mathematical integer.
`DoubleScalar.Rel<U>`	`round()` Set the value(s) to the closest long to the argument with ties rounding up.
`DoubleScalar.Rel<U>`	`signum()` Set the value(s) to the signum function of the value(s); zero if the argument is zero, 1.0 if the argument is greater than zero, -1.0 if the argument is less than zero.
`DoubleScalar.Rel<U>`	`sin()` Set the value(s) to the trigonometric sine of the value(s).
`DoubleScalar.Rel<U>`	`sinh()` Set the value(s) to the hyperbolic sine of the value(s).
`DoubleScalar.Rel<U>`	`sqrt()` Set the value(s) to the correctly rounded positive square root of the value(s).
`DoubleScalar.Rel<U>`	`tan()` Set the value(s) to the trigonometric tangent of the value(s).
`DoubleScalar.Rel<U>`	`tanh()` Set the value(s) to the hyperbolic tangent of the value(s).
`DoubleScalar.Rel<U>`	`toDegrees()` Set the value(s) to approximately equivalent angle(s) measured in degrees.
`DoubleScalar.Rel<U>`	`toRadians()` Set the value(s) to approximately equivalent angle(s) measured in radians.

Methods inherited from class org.djunits.value.vdouble.scalar.DoubleScalar
divide, divide, doubleValue, equals, floatValue, getInUnit, getInUnit, hashCode, interpolate, interpolate, intValue, longValue, minus, minus, minus, multiply, multiply, plus, plus, plus, toString, toString, toString, toString

Methods inherited from class org.djunits.value.Scalar
expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative

Methods inherited from class java.lang.Number
byteValue, shortValue

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
 - si
```
public final double si
```
 The value, stored in the standard SI unit.
- Constructor Detail
 - Rel
```
public Rel(double value,
 U unit)
```
 Construct a new Relative Immutable DoubleScalar.
 
 Parameters:
 
 value - double; the value of the new Relative Immutable DoubleScalar
 
 unit - U; the unit of the new Relative Immutable DoubleScalar
 - Rel
```
public Rel(DoubleScalar.Rel value)
```
 Construct a new Relative Immutable DoubleScalar from an existing Relative Immutable DoubleScalar.
 
 Parameters:
 
 value - DoubleScalar.Rel; the reference
- Method Detail
 - compareTo
```
public final int compareTo(DoubleScalar.Rel o)
```
 Specified by:
 
 compareTo in interface Comparable<DoubleScalar.Rel>>
 - getSI
```
public final double getSI()
```
 Retrieve the value in the underlying SI unit.
 
 Specified by:
 
 getSI in class DoubleScalar>
 
 Returns:
 
 double
 - lt
```
public final boolean lt(DoubleScalar.Rel o)
```
 Test if this DoubleScalar.Rel is less than a DoubleScalar.Rel.
 
 Parameters:
 
 o - DoubleScalar.Rel; the right hand side operand of the comparison
 
 Returns:
 
 boolean
 - le
```
public final boolean le(DoubleScalar.Rel o)
```
 Test if this DoubleScalar.Rel is less than or equal to a DoubleScalar.Rel.
 
 Parameters:
 
 o - DoubleScalar.Rel; the right hand side operand of the comparison
 
 Returns:
 
 boolean
 - gt
```
public final boolean gt(DoubleScalar.Rel o)
```
 Test if this DoubleScalar.Rel is greater than or equal to a DoubleScalar.Rel.
 
 Parameters:
 
 o - DoubleScalar.Rel; the right hand side operand of the comparison
 
 Returns:
 
 boolean
 - ge
```
public final boolean ge(DoubleScalar.Rel o)
```
 Test if this DoubleScalar.Rel is greater than a DoubleScalar.Rel.
 
 Parameters:
 
 o - DoubleScalar.Rel; the right hand side operand of the comparison
 
 Returns:
 
 boolean
 - eq
```
public final boolean eq(DoubleScalar.Rel o)
```
 Test if this DoubleScalar.Rel is equal to a DoubleScalar.Rel.
 
 Parameters:
 
 o - DoubleScalar.Rel; the right hand side operand of the comparison
 
 Returns:
 
 boolean
 - ne
```
public final boolean ne(DoubleScalar.Rel o)
```
 Test if this DoubleScalar.Rel is not equal to a DoubleScalar.Rel.
 
 Parameters:
 
 o - DoubleScalar.Rel; the right hand side operand of the comparison
 
 Returns:
 
 boolean
 - plus
```
public final DoubleScalar.Rel plus(DoubleScalar.Rel increment)
```
 Increment the value by the supplied value and return the result.
 
 Parameters:
 
 increment - DoubleScalar.Rel; amount by which the value is incremented
 
 Returns:
 
 DoubleScalar.Abs
 - minus
```
public final DoubleScalar.Rel minus(DoubleScalar.Rel decrement)
```
 Decrement the value by the supplied value and return the result.
 
 Parameters:
 
 decrement - DoubleScalar.Rel; amount by which the value is decremented
 
 Returns:
 
 DoubleScalar.Rel
 - abs
```
public DoubleScalar.Rel abs()
```
 Set the value(s) to their absolute value.
 
 Specified by:
 
 abs in interface MathFunctions<DoubleScalar>>
 
 Returns:
 
 T; the modified T
 - acos
```
public DoubleScalar.Rel acos()
```
 Set the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.
 
 Specified by:
 
 acos in interface MathFunctions<DoubleScalar>>
 
 Returns:
 
 T; the modified T
 - asin
```
public DoubleScalar.Rel asin()
```
 Set the value(s) to the arc sine of the value(s); the resulting angle is in the range -pi/2 through pi/2.
 
 Specified by:
 
 asin in interface MathFunctions<DoubleScalar>>
 
 Returns:
 
 T; the modified T
 - atan
```
public DoubleScalar.Rel atan()
```
 Set the value(s) to the arc tangent of the value(s); the resulting angle is in the range -pi/2 through pi/2.
 
 Specified by:
 
 atan in interface MathFunctions<DoubleScalar>>
 
 Returns:
 
 T; the modified T
 - cbrt
```
public DoubleScalar.Rel cbrt()
```
 Set the value(s) to the(ir) cube root.
 
 Specified by:
 
 cbrt in interface MathFunctions<DoubleScalar>>
 
 Returns:
 
 T; the modified T
 - ceil
```
public DoubleScalar.Rel ceil()
```
 Set the value(s) to the smallest (closest to negative infinity) value(s) that are greater than or equal to the argument and equal to a mathematical integer.
 
 Specified by:
 
 ceil in interface MathFunctions<DoubleScalar>>
 
 Returns:
 
 T; the modified T
 - cos
```
public DoubleScalar.Rel cos()
```
 Set the value(s) to the trigonometric cosine of the value(s).
 
 Specified by:
 
 cos in interface MathFunctions<DoubleScalar>>
 
 Returns:
 
 T; the modified T
 - cosh
```
public DoubleScalar.Rel cosh()
```
 Set the value(s) to the hyperbolic cosine of the value(s).
 
 Specified by:
 
 cosh in interface MathFunctions<DoubleScalar>>
 
 Returns:
 
 T; the modified T
 - exp
```
public DoubleScalar.Rel exp()
```
 Set the value(s) to Euler's number e raised to the power of the value(s).
 
 Specified by:
 
 exp in interface MathFunctions<DoubleScalar>>
 
 Returns:
 
 T; the modified T
 - expm1
```
public DoubleScalar.Rel expm1()
```
 Set the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).
 
 Specified by:
 
 expm1 in interface MathFunctions<DoubleScalar>>
 
 Returns:
 
 T; the modified T
 - floor
```
public DoubleScalar.Rel floor()
```
 Set the value(s) to the largest (closest to positive infinity) value(s) that are less than or equal to the argument and equal to a mathematical integer.
 
 Specified by:
 
 floor in interface MathFunctions<DoubleScalar>>
 
 Returns:
 
 T; the modified T
 - log
```
public DoubleScalar.Rel log()
```
 Set the value(s) to the natural logarithm (base e) of the value(s).
 
 Specified by:
 
 log in interface MathFunctions<DoubleScalar>>
 
 Returns:
 
 T; the modified T
 - log10
```
public DoubleScalar.Rel log10()
```
 Set the value(s) to the base 10 logarithm of the value(s).
 
 Specified by:
 
 log10 in interface MathFunctions<DoubleScalar>>
 
 Returns:
 
 T; the modified T
 - log1p
```
public DoubleScalar.Rel log1p()
```
 Set the value(s) to the natural logarithm of the sum of the value(s) and 1.
 
 Specified by:
 
 log1p in interface MathFunctions<DoubleScalar>>
 
 Returns:
 
 T; the modified T
 - pow
```
public DoubleScalar.Rel pow(double x)
```
 Set the value(s) to the value(s) raised to the power of the argument.
 
 Specified by:
 
 pow in interface MathFunctions<DoubleScalar>>
 
 Parameters:
 
 x - double; the value to use as the power
 
 Returns:
 
 T; the modified T
 - rint
```
public DoubleScalar.Rel rint()
```
 Set the value(s) to the value(s) that are closest in value to the argument and equal to a mathematical integer.
 
 Specified by:
 
 rint in interface MathFunctions<DoubleScalar>>
 
 Returns:
 
 T; the modified T
 - round
```
public DoubleScalar.Rel round()
```
 Set the value(s) to the closest long to the argument with ties rounding up.
 
 Specified by:
 
 round in interface MathFunctions<DoubleScalar>>
 
 Returns:
 
 T; the modified T
 - signum
```
public DoubleScalar.Rel signum()
```
 Set the value(s) to the signum function of the value(s); zero if the argument is zero, 1.0 if the argument is greater than zero, -1.0 if the argument is less than zero.
 
 Specified by:
 
 signum in interface MathFunctions<DoubleScalar>>
 
 Returns:
 
 T; the modified T
 - sin
```
public DoubleScalar.Rel sin()
```
 Set the value(s) to the trigonometric sine of the value(s).
 
 Specified by:
 
 sin in interface MathFunctions<DoubleScalar>>
 
 Returns:
 
 T; the modified T
 - sinh
```
public DoubleScalar.Rel sinh()
```
 Set the value(s) to the hyperbolic sine of the value(s).
 
 Specified by:
 
 sinh in interface MathFunctions<DoubleScalar>>
 
 Returns:
 
 T; the modified T
 - sqrt
```
public DoubleScalar.Rel sqrt()
```
 Set the value(s) to the correctly rounded positive square root of the value(s).
 
 Specified by:
 
 sqrt in interface MathFunctions<DoubleScalar>>
 
 Returns:
 
 T; the modified T
 - tan
```
public DoubleScalar.Rel tan()
```
 Set the value(s) to the trigonometric tangent of the value(s).
 
 Specified by:
 
 tan in interface MathFunctions<DoubleScalar>>
 
 Returns:
 
 T; the modified T
 - tanh
```
public DoubleScalar.Rel tanh()
```
 Set the value(s) to the hyperbolic tangent of the value(s).
 
 Specified by:
 
 tanh in interface MathFunctions<DoubleScalar>>
 
 Returns:
 
 T; the modified T
 - toDegrees
```
public DoubleScalar.Rel toDegrees()
```
 Set the value(s) to approximately equivalent angle(s) measured in degrees.
 
 Specified by:
 
 toDegrees in interface MathFunctions<DoubleScalar>>
 
 Returns:
 
 T; the modified T
 - toRadians
```
public DoubleScalar.Rel toRadians()
```
 Set the value(s) to approximately equivalent angle(s) measured in radians.
 
 Specified by:
 
 toRadians in interface MathFunctions<DoubleScalar>>
 
 Returns:
 
 T; the modified T
 - inv
```
public DoubleScalar.Rel inv()
```
 Set the value(s) to the complement (1.0/x) of the value(s).
 
 Specified by:
 
 inv in interface MathFunctions<DoubleScalar>>
 
 Returns:
 
 T; the modified T
 - multiplyBy
```
public DoubleScalar.Rel multiplyBy(double constant)
```
 Scale the value(s) by a factor.
 
 Specified by:
 
 multiplyBy in interface DoubleMathFunctions<DoubleScalar>>
 
 Parameters:
 
 constant - double; the multiplier
 
 Returns:
 
 T; the modified T
 - divideBy
```
public DoubleScalar.Rel divideBy(double constant)
```
 Scale the value(s) by the inverse of a factor; i.e. a divisor.
 
 Specified by:
 
 divideBy in interface DoubleMathFunctions<DoubleScalar>>
 
 Parameters:
 
 constant - double; the divisor
 
 Returns:
 
 T; the modified T

Class DoubleScalar.Rel<U extends Unit<U>>

Nested Class Summary

Nested classes/interfaces inherited from class org.djunits.value.vdouble.scalar.DoubleScalar

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.djunits.value.vdouble.scalar.DoubleScalar

Methods inherited from class org.djunits.value.Scalar

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Field Detail

si

Constructor Detail

Rel

Rel

Method Detail

compareTo

getSI

lt

le

gt

ge

eq

ne

plus

minus

abs

acos

asin

atan

cbrt

ceil

cos

cosh

exp

expm1

floor

log

log10

log1p

pow

rint

round

signum

sin

sinh

sqrt

tan

tanh

toDegrees

toRadians

inv

multiplyBy

divideBy