AbstractDoubleScalarAbs (DJUNITS 3.00.07 API)

java.lang.Object
- java.lang.Number
- - org.djunits.value.Scalar<U>
  - - org.djunits.value.vdouble.scalar.AbstractDoubleScalar<AU,A>
    - - org.djunits.value.vdouble.scalar.AbstractDoubleScalarAbs<AU,A,RU,R>

Type Parameters:

AU - the absolute unit

A - the Absolute class for reference purposes

RU - the relative unit

R - the Relative class for reference purposes

All Implemented Interfaces:

Serializable, Comparable<A>, Absolute, MathFunctionsAbs<A>, Value<AU>, DoubleMathFunctions<A>, DoubleScalarInterface

Direct Known Subclasses:

AbsoluteTemperature, Direction, DoubleScalar.Abs, Position, Time
```
public abstract class AbstractDoubleScalarAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends AbstractDoubleScalarAbs<AU,A,RU,R>,RU extends Unit<RU>,R extends AbstractDoubleScalarRel<RU,R>>
extends AbstractDoubleScalar<AU,A>
implements Absolute, MathFunctionsAbs<A>, DoubleMathFunctions<A>
```
The typed, abstract DoubleScalarAbs class that forms the basis of all DoubleScalar definitions and extensions.
Note: A relative scalar class can implement the toAbs() method if it has an absolute equivalent.
Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.
$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Oct 13, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalar
  si
- Fields inherited from interface org.djunits.value.vdouble.DoubleMathFunctions
  ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, NEG, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH

Constructor Summary

Constructors
Constructor and Description
`AbstractDoubleScalarAbs(A value)` Construct a new Absolute Immutable DoubleScalar from an existing Absolute Immutable DoubleScalar.
`AbstractDoubleScalarAbs(double value, AU unit)` Construct a new Absolute Immutable DoubleScalar.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`A`	`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.
`A`	`divideBy(double constant)` Scale the value(s) by the inverse of a factor; i.e.
`A`	`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.
`abstract A`	`instantiateAbs(double value, AU unit)` Construct a new Absolute Immutable DoubleScalar of the right type.
`abstract R`	`instantiateRel(double value, RU unit)` Construct a new Relative Immutable DoubleScalar of the right type.
`R`	`minus(A decrement)` Decrement the value by the supplied value and return the result using the relative unit belonging to the unit of the Absolute value.
`A`	`minus(R decrement)` Decrement the value by the supplied value and return the result using the current unit of the Absolute value.
`A`	`multiplyBy(double constant)` Scale the value(s) by a factor.
`A`	`plus(R increment)` Increment the value by the supplied value and return the result using the current unit of the Absolute value.
`A`	`rint()` Set the value(s) to the value(s) that are closest in value to the argument and equal to a mathematical integer.
`A`	`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.AbstractDoubleScalar
compareTo, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, intValue, le, le0, longValue, lt, lt0, ne, ne0, toString, toString, toString, toString

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

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

- Constructor Detail
  - AbstractDoubleScalarAbs
```
public AbstractDoubleScalarAbs(double value,
                               AU 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
  - AbstractDoubleScalarAbs
```
public AbstractDoubleScalarAbs(A value)
```
    Construct a new Absolute Immutable DoubleScalar from an existing Absolute Immutable DoubleScalar.
    
    Parameters:
    
    value - A, an absolute typed DoubleScalar; the reference
- Method Detail
  - instantiateAbs
```
public abstract A instantiateAbs(double value,
                                 AU unit)
```
    Construct a new Absolute Immutable DoubleScalar of the right type. Each extending class must implement this method.
    
    Parameters:
    
    value - the double value
    
    unit - the unit
    
    Returns:
    
    A a new absolute instance of the DoubleScalar of the right type
  - instantiateRel
```
public abstract R instantiateRel(double value,
                                 RU unit)
```
    Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.
    
    Parameters:
    
    value - the double value
    
    unit - the unit
    
    Returns:
    
    R a new relative instance of the DoubleScalar of the right type
  - plus
```
public final A plus(R increment)
```
    Increment the value by the supplied value and return the result using the current unit of the Absolute value.
    
    Parameters:
    
    increment - R, a relative typed DoubleScalar; amount by which the value is incremented
    
    Returns:
    
    Absolute DoubleScalar
  - minus
```
public final A minus(R decrement)
```
    Decrement the value by the supplied value and return the result using the current unit of the Absolute value.
    
    Parameters:
    
    decrement - R, a relative typed DoubleScalar; amount by which the value is decremented
    
    Returns:
    
    Absolute DoubleScalar
  - minus
```
public final R minus(A decrement)
```
    Decrement the value by the supplied value and return the result using the relative unit belonging to the unit of the Absolute value.
    
    Parameters:
    
    decrement - A, an absolute typed DoubleScalar; amount by which the value is decremented
    
    Returns:
    
    Relative DoubleScalar
  - ceil
```
public A 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<A extends AbstractDoubleScalarAbs<AU,A,RU,R>>
    
    Returns:
    
    T; the modified T
  - floor
```
public A 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<A extends AbstractDoubleScalarAbs<AU,A,RU,R>>
    
    Returns:
    
    T; the modified T
  - rint
```
public A 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<A extends AbstractDoubleScalarAbs<AU,A,RU,R>>
    
    Returns:
    
    T; the modified T
  - round
```
public A round()
```
    Set the value(s) to the closest long to the argument with ties rounding up.
    
    Specified by:
    
    round in interface MathFunctionsAbs<A extends AbstractDoubleScalarAbs<AU,A,RU,R>>
    
    Returns:
    
    T; the modified T
  - multiplyBy
```
public A multiplyBy(double constant)
```
    Scale the value(s) by a factor.
    
    Specified by:
    
    multiplyBy in interface DoubleMathFunctions<A extends AbstractDoubleScalarAbs<AU,A,RU,R>>
    
    Parameters:
    
    constant - double; the multiplier
    
    Returns:
    
    T; the modified T
  - divideBy
```
public A divideBy(double constant)
```
    Scale the value(s) by the inverse of a factor; i.e. a divisor.
    
    Specified by:
    
    divideBy in interface DoubleMathFunctions<A extends AbstractDoubleScalarAbs<AU,A,RU,R>>
    
    Parameters:
    
    constant - double; the divisor
    
    Returns:
    
    T; the modified T

Class AbstractDoubleScalarAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends AbstractDoubleScalarAbs<AU,A,RU,R>,RU extends Unit<RU>,R extends AbstractDoubleScalarRel<RU,R>>

Field Summary

Fields inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalar

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

Constructor Summary

Method Summary

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

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

Constructor Detail

AbstractDoubleScalarAbs

AbstractDoubleScalarAbs

Method Detail

instantiateAbs

instantiateRel

plus

minus

minus

ceil

floor

rint

round

multiplyBy

divideBy