DoubleScalar.Abs (DJUNITS 1.03.01 API)

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

Type Parameters:

U - Unit

All Implemented Interfaces:

Serializable, Comparable<DoubleScalar.Abs>, Absolute, MathFunctionsAbs<DoubleScalar.Abs>, Value, DoubleMathFunctions<DoubleScalar>

Direct Known Subclasses:

TypedDoubleScalarAbs

Enclosing class:

DoubleScalar>
```
public static class DoubleScalar.Abs>
extends DoubleScalar
implements Absolute, Comparable<DoubleScalar.Abs>, MathFunctionsAbs<DoubleScalar.Abs>
```
Absolute Immutable DoubleScalar.

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 inherited from interface org.djunits.value.vdouble.DoubleMathFunctions
  ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH

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

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DoubleScalar.Abs<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.Abs<U> o)`
`DoubleScalar.Abs<U>`	`divideBy(double constant)` Scale the value(s) by the inverse of a factor; i.e.
`boolean`	`eq(DoubleScalar.Abs<U> o)` Test if this DoubleScalar.Abs<U> is equal to a DoubleScalar.Abs<U>.
`DoubleScalar.Abs<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.Abs<U> o)` Test if this DoubleScalar.Abs<U> is greater than a DoubleScalar.Abs<U>.
`double`	`getSI()` Retrieve the value in the underlying SI unit.
`boolean`	`gt(DoubleScalar.Abs<U> o)` Test if this DoubleScalar.Abs<U> is greater than or equal to a DoubleScalar.Abs<U>.
`boolean`	`le(DoubleScalar.Abs<U> o)` Test if this DoubleScalar.Abs<U> is less than or equal to a DoubleScalar.Abs<U>.
`boolean`	`lt(DoubleScalar.Abs<U> o)` Test if this DoubleScalar.Abs<U> is less than a DoubleScalar.Abs<U>.
`DoubleScalar.Rel<U>`	`minus(DoubleScalar.Abs<U> decrement)` Decrement the value by the supplied value and return the result.
`DoubleScalar.Abs<U>`	`minus(DoubleScalar.Rel<U> decrement)` Decrement the value by the supplied value and return the result.
`DoubleScalar.Abs<U>`	`multiplyBy(double constant)` Scale the value(s) by a factor.
`boolean`	`ne(DoubleScalar.Abs<U> o)` Test if this DoubleScalar.Abs<U> is not equal to a DoubleScalar.Abs<U>.
`DoubleScalar.Abs<U>`	`plus(DoubleScalar.Rel<U> increment)` Increment the value by the supplied value and return the result.
`DoubleScalar.Abs<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.Abs<U>`	`round()` Set the value(s) to the closest long to the argument with ties rounding up.

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

Methods inherited from interface org.djunits.value.vdouble.DoubleMathFunctions
DIV, MULT, POW

- Field Detail
 - si
```
public final double si
```
 The value, stored in the standard SI unit.
- Constructor Detail
 - Abs
```
public Abs(double value,
 U unit)
```
 Construct a new Absolute Immutable DoubleScalar.
 
 Parameters:
 
 value - double; the value of the new Absolute Immutable DoubleScalar
 
 unit - U; the unit of the new Absolute Immutable DoubleScalar
 - Abs
```
public Abs(DoubleScalar.Abs value)
```
 Construct a new Absolute Immutable DoubleScalar from an existing Absolute Immutable DoubleScalar.
 
 Parameters:
 
 value - DoubleScalar.Abs; the reference
- Method Detail
 - compareTo
```
public final int compareTo(DoubleScalar.Abs o)
```
 Specified by:
 
 compareTo in interface Comparable<DoubleScalar.Abs>>
 - 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.Abs o)
```
 Test if this DoubleScalar.Abs is less than a DoubleScalar.Abs.
 
 Parameters:
 
 o - DoubleScalar.Abs; the right hand side operand of the comparison
 
 Returns:
 
 boolean
 - le
```
public final boolean le(DoubleScalar.Abs o)
```
 Test if this DoubleScalar.Abs is less than or equal to a DoubleScalar.Abs.
 
 Parameters:
 
 o - DoubleScalar.Abs; the right hand side operand of the comparison
 
 Returns:
 
 boolean
 - gt
```
public final boolean gt(DoubleScalar.Abs o)
```
 Test if this DoubleScalar.Abs is greater than or equal to a DoubleScalar.Abs.
 
 Parameters:
 
 o - DoubleScalar.Abs; the right hand side operand of the comparison
 
 Returns:
 
 boolean
 - ge
```
public final boolean ge(DoubleScalar.Abs o)
```
 Test if this DoubleScalar.Abs is greater than a DoubleScalar.Abs.
 
 Parameters:
 
 o - DoubleScalar.Abs; the right hand side operand of the comparison
 
 Returns:
 
 boolean
 - eq
```
public final boolean eq(DoubleScalar.Abs o)
```
 Test if this DoubleScalar.Abs is equal to a DoubleScalar.Abs.
 
 Parameters:
 
 o - DoubleScalar.Abs; the right hand side operand of the comparison
 
 Returns:
 
 boolean
 - ne
```
public final boolean ne(DoubleScalar.Abs o)
```
 Test if this DoubleScalar.Abs is not equal to a DoubleScalar.Abs.
 
 Parameters:
 
 o - DoubleScalar.Abs; the right hand side operand of the comparison
 
 Returns:
 
 boolean
 - plus
```
public final DoubleScalar.Abs 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.Abs 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.Abs
 - minus
```
public final DoubleScalar.Rel minus(DoubleScalar.Abs decrement)
```
 Decrement the value by the supplied value and return the result.
 
 Parameters:
 
 decrement - DoubleScalar.Abs; amount by which the value is decremented
 
 Returns:
 
 DoubleScalar.Rel
 - ceil
```
public DoubleScalar.Abs 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 MathFunctionsAbs<DoubleScalar.Abs>>
 
 Returns:
 
 T; the modified T
 - floor
```
public DoubleScalar.Abs 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 MathFunctionsAbs<DoubleScalar.Abs>>
 
 Returns:
 
 T; the modified T
 - rint
```
public DoubleScalar.Abs 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 MathFunctionsAbs<DoubleScalar.Abs>>
 
 Returns:
 
 T; the modified T
 - round
```
public DoubleScalar.Abs round()
```
 Set the value(s) to the closest long to the argument with ties rounding up.
 
 Specified by:
 
 round in interface MathFunctionsAbs<DoubleScalar.Abs>>
 
 Returns:
 
 T; the modified T
 - multiplyBy
```
public DoubleScalar.Abs 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.Abs 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.Abs<U extends Unit<U>>

Nested Class Summary

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

Field Summary

Fields inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

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

Methods inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

Field Detail

si

Constructor Detail

Abs

Abs

Method Detail

compareTo

getSI

lt

le

gt

ge

eq

ne

plus

minus

minus

ceil

floor

rint

round

multiplyBy

divideBy