FloatScalar (DJUNITS 1.03.01 API)

java.lang.Object
- java.lang.Number
- - org.djunits.value.Scalar
 - - org.djunits.value.vfloat.scalar.FloatScalar

Type Parameters:

U - Unit; the unit of this FloatScalar

All Implemented Interfaces:

Serializable, Value, FloatMathFunctions<FloatScalar>

Direct Known Subclasses:

FloatScalar.Abs, FloatScalar.Rel
```
public abstract class FloatScalar>
extends Scalar
implements FloatMathFunctions<FloatScalar>
```
Immutable FloatScalar.
This file was generated by the djunits value classes generator, 26 jun, 2015
Copyright (c) 2015-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.
$LastChangedDate: 2016-05-28 14:25:52 +0200 (Sat, 28 May 2016) $, @version $Revision: 202 $, by $Author: averbraeck $, initial version 26 jun, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FloatScalar.Abs>

static class FloatScalar.Rel>

Nested Classes
Modifier and Type	Class and Description
`static class`	`FloatScalar.Abs<U extends Unit<U>>`
`static class`	`FloatScalar.Rel<U extends Unit<U>>`

Field Summary
- Fields inherited from interface org.djunits.value.vfloat.FloatMathFunctions
  ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH, TO_DEGREES, TO_RADIANS

Constructor Summary

Constructors
Modifier Constructor and Description

protected FloatScalar(U unit)
Construct a new Immutable FloatScalar.

Constructors
Modifier	Constructor and Description
`protected`	`FloatScalar(U unit)` Construct a new Immutable FloatScalar.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static FloatScalar.Abs<SIUnit>`	`divide(FloatScalar.Abs<?> left, FloatScalar.Abs<?> right)` Divide two values; the result is a new instance with a different (existing or generated) SI unit.
`static FloatScalar.Rel<SIUnit>`	`divide(FloatScalar.Rel<?> left, FloatScalar.Rel<?> right)` Divide two values; the result is a new instance with a different (existing or generated) SI unit.
`double`	`doubleValue()`
`boolean`	`equals(Object obj)`
`float`	`floatValue()`
`float`	`getInUnit()` Retrieve the value in the original unit.
`float`	`getInUnit(U targetUnit)` Retrieve the value converted into some specified unit.
`abstract float`	`getSI()` Retrieve the value in the underlying SI unit.
`int`	`hashCode()`
`static <U extends Unit<U>> FloatScalar.Abs<U>`	`interpolate(FloatScalar.Abs<U> zero, FloatScalar.Abs<U> one, float ratio)` Interpolate between or extrapolate over two values.
`static <U extends Unit<U>> FloatScalar.Rel<U>`	`interpolate(FloatScalar.Rel<U> zero, FloatScalar.Rel<U> one, float ratio)` Interpolate between or extrapolate over two values.
`int`	`intValue()`
`long`	`longValue()`
`static <U extends Unit<U>> FloatScalar.Rel<U>`	`minus(FloatScalar.Abs<U> left, FloatScalar.Abs<U> right)` Subtract two absolute values.
`static <U extends Unit<U>> FloatScalar.Abs<U>`	`minus(FloatScalar.Abs<U> left, FloatScalar.Rel<U> right)` Subtract a Relative value from an absolute value.
`static <U extends Unit<U>> FloatScalar.Rel<U>`	`minus(FloatScalar.Rel<U> left, FloatScalar.Rel<U> right)` Subtract a relative value from a relative value.
`static FloatScalar.Abs<SIUnit>`	`multiply(FloatScalar.Abs<?> left, FloatScalar.Abs<?> right)` Multiply two values; the result is a new instance with a different (existing or generated) SI unit.
`static FloatScalar.Rel<SIUnit>`	`multiply(FloatScalar.Rel<?> left, FloatScalar.Rel<?> right)` Multiply two values; the result is a new instance with a different (existing or generated) SI unit.
`static <U extends Unit<U>> FloatScalar.Abs<U>`	`plus(FloatScalar.Abs<U> left, FloatScalar.Rel<U> right)` Add a Relative value to an Absolute value.
`static <U extends Unit<U>> FloatScalar.Abs<U>`	`plus(FloatScalar.Rel<U> left, FloatScalar.Abs<U> right)` Add an Absolute value to a Relative value.
`static <U extends Unit<U>> FloatScalar.Rel<U>`	`plus(FloatScalar.Rel<U> left, FloatScalar.Rel<U> right)` Add a Relative value to a Relative value.
`String`	`toString()`
`String`	`toString(boolean verbose, boolean withUnit)` Print this FloatScalar with optional type and unit information.
`String`	`toString(U displayUnit)` Print this FloatScalar with the value expressed in the specified unit.
`String`	`toString(U displayUnit, boolean verbose, boolean withUnit)` Print this FloatScalar with the value expressed in the specified unit.

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.vfloat.FloatMathFunctions
DIV, divideBy, MULT, multiplyBy, POW

- Constructor Detail
 - FloatScalar
```
protected FloatScalar(U unit)
```
 Construct a new Immutable FloatScalar.
 
 Parameters:
 
 unit - U; the unit of the new FloatScalar
- Method Detail
 - getSI
```
public abstract float getSI()
```
 Retrieve the value in the underlying SI unit.
 
 Returns:
 
 float
 - getInUnit
```
public final float getInUnit()
```
 Retrieve the value in the original unit.
 
 Returns:
 
 float
 - getInUnit
```
public final float getInUnit(U targetUnit)
```
 Retrieve the value converted into some specified unit.
 
 Parameters:
 
 targetUnit - U; the unit to convert the value into
 
 Returns:
 
 float
 - intValue
```
public final int intValue()
```
 Specified by:
 
 intValue in class Number
 - longValue
```
public final long longValue()
```
 Specified by:
 
 longValue in class Number
 - floatValue
```
public final float floatValue()
```
 Specified by:
 
 floatValue in class Number
 - doubleValue
```
public final double doubleValue()
```
 Specified by:
 
 doubleValue in class Number
 - toString
```
public final String toString()
```
 Overrides:
 
 toString in class Object
 - toString
```
public final String toString(U displayUnit)
```
 Print this FloatScalar with the value expressed in the specified unit.
 
 Parameters:
 
 displayUnit - U; the unit into which the value is converted for display
 
 Returns:
 
 String; printable string with the scalar contents expressed in the specified unit
 - toString
```
public final String toString(boolean verbose,
 boolean withUnit)
```
 Print this FloatScalar with optional type and unit information.
 
 Parameters:
 
 verbose - boolean; if true; include type info; if false; exclude type info
 
 withUnit - boolean; if true; include the unit; of false; exclude the unit
 
 Returns:
 
 String; printable string with the scalar contents
 - toString
```
public final String toString(U displayUnit,
 boolean verbose,
 boolean withUnit)
```
 Print this FloatScalar with the value expressed in the specified unit.
 
 Parameters:
 
 displayUnit - U; the unit into which the value is converted for display
 
 verbose - boolean; if true; include type info; if false; exclude type info
 
 withUnit - boolean; if true; include the unit; of false; exclude the unit
 
 Returns:
 
 String; printable string with the scalar contents
 - hashCode
```
public final int hashCode()
```
 Overrides:
 
 hashCode in class Object
 - equals
```
public final boolean equals(Object obj)
```
 Overrides:
 
 equals in class Object
 - plus
```
public static > FloatScalar.Abs plus(FloatScalar.Abs left,
 FloatScalar.Rel right)
```
 Add a Relative value to an Absolute value. Return a new instance of the value. The unit of the return value will be the unit of the left argument.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - FloatScalar.Abs; the left argument
 
 right - FloatScalar.Rel; the right argument
 
 Returns:
 
 FloatScalar.Abs; the sum of the values as an Absolute value
 - plus
```
public static > FloatScalar.Abs plus(FloatScalar.Rel left,
 FloatScalar.Abs right)
```
 Add an Absolute value to a Relative value. Return a new instance of the value. The unit of the return value will be the unit of the left argument.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - FloatScalar.Abs; the left argument
 
 right - FloatScalar.Rel; the right argument
 
 Returns:
 
 FloatScalar.Abs; the sum of the values as an Absolute value
 - plus
```
public static > FloatScalar.Rel plus(FloatScalar.Rel left,
 FloatScalar.Rel right)
```
 Add a Relative value to a Relative value. Return a new instance of the value. The unit of the return value will be the unit of the left argument.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - FloatScalar.Rel; the left argument
 
 right - FloatScalar.Rel; the right argument
 
 Returns:
 
 FloatScalar.Rel; the sum of the values as a Relative value
 - minus
```
public static > FloatScalar.Abs minus(FloatScalar.Abs left,
 FloatScalar.Rel right)
```
 Subtract a Relative value from an absolute value. Return a new instance of the value. The unit of the return value will be the unit of the left argument.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - FloatScalar.Abs; the left value
 
 right - FloatScalar.Rel; the right value
 
 Returns:
 
 FloatScalar.Abs; the resulting value as an absolute value
 - minus
```
public static > FloatScalar.Rel minus(FloatScalar.Rel left,
 FloatScalar.Rel right)
```
 Subtract a relative value from a relative value. Return a new instance of the value. The unit of the value will be the unit of the first argument.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - FloatScalar.Rel; the left value
 
 right - FloatScalar.Rel; the right value
 
 Returns:
 
 FloatScalar.Rel; the resulting value as a relative value
 - minus
```
public static > FloatScalar.Rel minus(FloatScalar.Abs left,
 FloatScalar.Abs right)
```
 Subtract two absolute values. Return a new instance of a relative value of the difference. The unit of the value will be the unit of the first argument.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 left - FloatScalar.Abs; value 1
 
 right - FloatScalar.Abs; value 2
 
 Returns:
 
 FloatScalar.Rel; the difference of the two absolute values as a relative value
 - multiply
```
public static FloatScalar.Abs<SIUnit> multiply(FloatScalar.Abs<?> left,
 FloatScalar.Abs<?> right)
```
 Multiply two values; the result is a new instance with a different (existing or generated) SI unit.
 
 Parameters:
 
 left - FloatScalar.Abs<?>; the left operand
 
 right - FloatScalar.Abs<?>; the right operand
 
 Returns:
 
 FloatScalar.Abs<SIUnit>; the product of the two values
 - multiply
```
public static FloatScalar.Rel<SIUnit> multiply(FloatScalar.Rel<?> left,
 FloatScalar.Rel<?> right)
```
 Multiply two values; the result is a new instance with a different (existing or generated) SI unit.
 
 Parameters:
 
 left - FloatScalar.Rel<?>; the left operand
 
 right - FloatScalar.Rel<?>; the right operand
 
 Returns:
 
 FloatScalar.Rel<SIUnit>; the product of the two values
 - divide
```
public static FloatScalar.Abs<SIUnit> divide(FloatScalar.Abs<?> left,
 FloatScalar.Abs<?> right)
```
 Divide two values; the result is a new instance with a different (existing or generated) SI unit.
 
 Parameters:
 
 left - FloatScalar.Abs<?>; the left operand
 
 right - FloatScalar.Abs<?>; the right operand
 
 Returns:
 
 FloatScalar.Abs<SIUnit>; the ratio of the two values
 - divide
```
public static FloatScalar.Rel<SIUnit> divide(FloatScalar.Rel<?> left,
 FloatScalar.Rel<?> right)
```
 Divide two values; the result is a new instance with a different (existing or generated) SI unit.
 
 Parameters:
 
 left - FloatScalar.Rel<?>; the left operand
 
 right - FloatScalar.Rel<?>; the right operand
 
 Returns:
 
 FloatScalar.Rel<SIUnit>; the ratio of the two values
 - interpolate
```
public static > FloatScalar.Abs interpolate(FloatScalar.Abs zero,
 FloatScalar.Abs one,
 float ratio)
```
 Interpolate between or extrapolate over two values.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 zero - FloatScalar.Abs; zero reference (returned when ratio == 0)
 
 one - FloatScalar.Abs; one reference (returned when ratio == 1)
 
 ratio - float; the ratio that determines where between (or outside) zero and one the result lies
 
 Returns:
 
 FloatScalar.Abs
 - interpolate
```
public static > FloatScalar.Rel interpolate(FloatScalar.Rel zero,
 FloatScalar.Rel one,
 float ratio)
```
 Interpolate between or extrapolate over two values.
 
 Type Parameters:
 
 U - Unit; the unit of the parameters and the result
 
 Parameters:
 
 zero - FloatScalar.Rel; zero reference (returned when ratio == 0)
 
 one - FloatScalar.Rel; one reference (returned when ratio == 1)
 
 ratio - float; the ratio that determines where between (or outside) zero and one the result lies
 
 Returns:
 
 FloatScalar.Rel

Class FloatScalar<U extends Unit<U>>

Nested Class Summary

Field Summary

Fields inherited from interface org.djunits.value.vfloat.FloatMathFunctions

Constructor Summary

Method Summary

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.vfloat.FloatMathFunctions

Constructor Detail

FloatScalar

Method Detail

getSI

getInUnit

getInUnit

intValue

longValue

floatValue

doubleValue

toString

toString

toString

toString

hashCode

equals

plus

plus

plus

minus

minus

minus

multiply

multiply

divide

divide

interpolate

interpolate