AbstractMeasure (Manifold :: Science 2021.1.10 API)

java.lang.Object
- manifold.science.api.AbstractMeasure<U,T>

Type Parameters:

U - The unit corresponding with the type e.g., Length specifies LengthUnit.

T - This type. Note this type is recursive to enforce type-safety, normally the complicated generics are not exposed to users of the library e.g., see the Length measure.

All Implemented Interfaces:

Serializable, Comparable<T>, Sequential<T,manifold.science.util.Rational,U>, ComparableUsing<T>, Dimension<T>
```
public abstract class AbstractMeasure<U extends Unit<T,U>,T extends AbstractMeasure<U,T>>
extends Object
implements Dimension<T>, Sequential<T,manifold.science.util.Rational,U>
```
This class serves as the base class for a measured quantity. See Length, Velocity, Mass, etc. for examples.
Instances of this class store the value (or magnitude) of the measure in terms of base units. Thus all arithmetic on measures is performed using Base units, which permits measures of differing input units to work in calculations. A measure instance also maintains a "display unit", which is used for display purposes and for working with other systems requiring specific units.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface manifold.ext.rt.api.ComparableUsing
  ComparableUsing.EqualityMode, ComparableUsing.Operator

Constructor Summary

Constructors
Constructor and Description

AbstractMeasure(manifold.science.util.Rational value, U unit, U displayUnit)

Constructors
Constructor and Description
`AbstractMeasure(manifold.science.util.Rational value, U unit, U displayUnit)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(T that)`
`T`	`copy(manifold.science.util.Rational value)` Given a value produce a copy of this dimension with the given value
`T`	`copy(U dsiplayUnit)` Copies this instance with a new display unit.
`manifold.science.util.Rational`	`div(T operand)`
`ComparableUsing.EqualityMode`	`equalityMode()` Use `#compareTo(T)` to implement the `==` operator as it does not take into account the `_displayUnit` which is inconsequential wrt the measure.
`boolean`	`equals(Object o)`
`T`	`fromBaseNumber(manifold.science.util.Rational p0)`
`T`	`fromNumber(manifold.science.util.Rational p0)`
`abstract U`	`getBaseUnit()` The unit on which all instances of this type are based.
`U`	`getDisplayUnit()`
`manifold.science.util.Rational`	`getValue()`
`int`	`hashCode()`
`abstract T`	`make(manifold.science.util.Rational value, U unit)` Creates a new instance using the specified parameters.
`abstract T`	`make(manifold.science.util.Rational value, U unit, U displayUnit)` Creates a new instance using the specified parameters.
`T`	`minus(T operand)`
`T`	`nextInSequence(manifold.science.util.Rational step, U unit)`
`T`	`nextNthInSequence(manifold.science.util.Rational step, U unit, int index)`
`T`	`plus(T operand)`
`T`	`previousInSequence(manifold.science.util.Rational step, U unit)`
`T`	`previousNthInSequence(manifold.science.util.Rational step, U unit, int index)`
`manifold.science.util.Rational`	`rem(T operand)`
`T`	`to(U displayUnit)` Copy this measure using the specified `displayUnit`.
`manifold.science.util.Rational`	`toBaseNumber()`
`String`	`toMixedString()`
`manifold.science.util.Rational`	`toNumber()`
`manifold.science.util.Rational`	`toNumber(U unit)` Get the magnitude of this measure in terms of the specified `unit`.
`String`	`toString()`

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

Methods inherited from interface manifold.science.api.Dimension
div, rem, times, unaryMinus

Methods inherited from interface manifold.ext.rt.api.ComparableUsing
compareToUsing

- Constructor Detail
  - AbstractMeasure
```
public AbstractMeasure(manifold.science.util.Rational value,
                       U unit,
                       U displayUnit)
```
    Parameters:
    
    value - The value (or magnitude) of this measure instance
    
    unit - The unit corresponding to the provided value
    
    displayUnit - The unit in which to display this measure
- Method Detail
  - getBaseUnit
```
public abstract U getBaseUnit()
```
    The unit on which all instances of this type are based. For instance, a Length dimension might use Meters as the base unit because it is the SI standard.
  - make
```
public abstract T make(manifold.science.util.Rational value,
                       U unit,
                       U displayUnit)
```
    Creates a new instance using the specified parameters.
  - make
```
public abstract T make(manifold.science.util.Rational value,
                       U unit)
```
    Creates a new instance using the specified parameters.
  - copy
```
public T copy(U dsiplayUnit)
```
    Copies this instance with a new display unit.
  - copy
```
public T copy(manifold.science.util.Rational value)
```
    Description copied from interface: Dimension
    
    Given a value produce a copy of this dimension with the given value
    
    Specified by:
    
    copy in interface Dimension<T extends AbstractMeasure<U,T>>
  - getValue
```
public manifold.science.util.Rational getValue()
```
    Returns:
    
    The value of this measure in Base units.
  - getDisplayUnit
```
public U getDisplayUnit()
```
    Returns:
    
    The unit in which this measure displays.
  - fromNumber
```
public T fromNumber(manifold.science.util.Rational p0)
```
    Specified by:
    
    fromNumber in interface Dimension<T extends AbstractMeasure<U,T>>
    
    Returns:
    
    a separate instance of this type with the given value.
  - fromBaseNumber
```
public T fromBaseNumber(manifold.science.util.Rational p0)
```
  - toNumber
```
public manifold.science.util.Rational toNumber()
```
    Specified by:
    
    toNumber in interface Dimension<T extends AbstractMeasure<U,T>>
    
    Returns:
    
    The magnitude of this measure in terms of Display units.
  - toBaseNumber
```
public manifold.science.util.Rational toBaseNumber()
```
    Specified by:
    
    toBaseNumber in interface Dimension<T extends AbstractMeasure<U,T>>
    
    Returns:
    
    The magnitude of this measure in terms of Base units.
  - to
```
public T to(U displayUnit)
```
    Copy this measure using the specified displayUnit.
  - toNumber
```
public manifold.science.util.Rational toNumber(U unit)
```
    Get the magnitude of this measure in terms of the specified unit.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toMixedString
```
public String toMixedString()
```
    Returns:
    
    The measure as a mixed fraction such as "2 1/8 kg"
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - equalityMode
```
public ComparableUsing.EqualityMode equalityMode()
```
    Use #compareTo(T) to implement the == operator as it does not take into account the _displayUnit which is inconsequential wrt the measure.
    
    Specified by:
    
    equalityMode in interface ComparableUsing<T extends AbstractMeasure<U,T>>
  - compareTo
```
public int compareTo(T that)
```
    Specified by:
    
    compareTo in interface Comparable<T extends AbstractMeasure<U,T>>
  - nextInSequence
```
public T nextInSequence(manifold.science.util.Rational step,
                        U unit)
```
    Specified by:
    
    nextInSequence in interface Sequential<T extends AbstractMeasure<U,T>,manifold.science.util.Rational,U extends Unit<T,U>>
  - nextNthInSequence
```
public T nextNthInSequence(manifold.science.util.Rational step,
                           U unit,
                           int index)
```
    Specified by:
    
    nextNthInSequence in interface Sequential<T extends AbstractMeasure<U,T>,manifold.science.util.Rational,U extends Unit<T,U>>
  - previousInSequence
```
public T previousInSequence(manifold.science.util.Rational step,
                            U unit)
```
    Specified by:
    
    previousInSequence in interface Sequential<T extends AbstractMeasure<U,T>,manifold.science.util.Rational,U extends Unit<T,U>>
  - previousNthInSequence
```
public T previousNthInSequence(manifold.science.util.Rational step,
                               U unit,
                               int index)
```
    Specified by:
    
    previousNthInSequence in interface Sequential<T extends AbstractMeasure<U,T>,manifold.science.util.Rational,U extends Unit<T,U>>
  - plus
```
public T plus(T operand)
```
    Specified by:
    
    plus in interface Dimension<T extends AbstractMeasure<U,T>>
  - minus
```
public T minus(T operand)
```
    Specified by:
    
    minus in interface Dimension<T extends AbstractMeasure<U,T>>
  - div
```
public manifold.science.util.Rational div(T operand)
```
    Specified by:
    
    div in interface Dimension<T extends AbstractMeasure<U,T>>
  - rem
```
public manifold.science.util.Rational rem(T operand)
```
    Specified by:
    
    rem in interface Dimension<T extends AbstractMeasure<U,T>>

Class AbstractMeasure<U extends Unit<T,U>,T extends AbstractMeasure<U,T>>

Nested Class Summary

Nested classes/interfaces inherited from interface manifold.ext.rt.api.ComparableUsing

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface manifold.science.api.Dimension

Methods inherited from interface manifold.ext.rt.api.ComparableUsing

Constructor Detail

AbstractMeasure

Method Detail

getBaseUnit

make

make

copy

copy

getValue

getDisplayUnit

fromNumber

fromBaseNumber

toNumber

toBaseNumber

to

toNumber

toString

toMixedString

hashCode

equals

equalityMode

compareTo

nextInSequence

nextNthInSequence

previousInSequence

previousNthInSequence

plus

minus

div

rem