org.djunits.value.vfloat.scalar

Class FloatPosition

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vfloat.scalar.AbstractFloatScalar<AU,A>

org.djunits.value.vfloat.scalar.AbstractFloatScalarAbs<PositionUnit,FloatPosition,LengthUnit,FloatLength>

org.djunits.value.vfloat.scalar.FloatPosition

All Implemented Interfaces:

Serializable, Comparable<FloatPosition>, Absolute, MathFunctionsAbs<FloatPosition>, Value<PositionUnit>, FloatMathFunctions<FloatPosition>, FloatScalarInterface

public class FloatPosition
extends AbstractFloatScalarAbs<PositionUnit,FloatPosition,LengthUnit,FloatLength>

Easy access methods for the Position FloatScalar. Instead of:

 FloatScalar.Abs<PositionUnit> value = new FloatScalar.Abs<PositionUnit>(100.0, PositionUnit.SI);
 

we can now write:

 FloatPosition value = new FloatPosition(100.0, PositionUnit.SI);
 

The compiler will automatically recognize which units belong to which quantity, and whether the quantity type and the unit used are compatible.

Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands.
All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2017-01-30 14:23:11 +0100 (Mon, 30 Jan 2017) $, @version $Revision: 234 $, by $Author: averbraeck $, initial version Sep 1, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static FloatPosition	ZERO constant with value zero.

Fields inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalar

si

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

ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, NEG, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH, TO_DEGREES, TO_RADIANS

Constructor Summary

Constructors

Constructor and Description
FloatPosition(double value, PositionUnit unit) Construct FloatPosition scalar using a double value.
FloatPosition(FloatPosition value) Construct FloatPosition scalar.
FloatPosition(float value, PositionUnit unit) Construct FloatPosition scalar.

Method Summary

Modifier and Type	Method and Description
static FloatPosition	createSI(float value) Construct FloatPosition scalar.
FloatPosition	instantiateAbs(float value, PositionUnit unit) Construct a new Absolute Immutable FloatScalar of the right type.
FloatLength	instantiateRel(float value, LengthUnit unit) Construct a new Relative Immutable FloatScalar of the right type.
static FloatPosition	interpolate(FloatPosition zero, FloatPosition one, float ratio) Interpolate between two values.
static FloatPosition	max(FloatPosition a1, FloatPosition a2) Return the maximum value of two absolute scalars.
static FloatPosition	max(FloatPosition a1, FloatPosition a2, FloatPosition... an) Return the maximum value of more than two absolute scalars.
static FloatPosition	min(FloatPosition a1, FloatPosition a2) Return the minimum value of two absolute scalars.
static FloatPosition	min(FloatPosition a1, FloatPosition a2, FloatPosition... an) Return the minimum value of more than two absolute scalars.

Methods inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalarAbs

ceil, divideBy, floor, minus, minus, multiplyBy, plus, rint, round

Methods inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalar

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

DIV, MULT, POW

Field Detail

ZERO

public static final FloatPosition ZERO

constant with value zero.

Constructor Detail

FloatPosition

public FloatPosition(float value,
                     PositionUnit unit)

Construct FloatPosition scalar.

Parameters:

value - float value

unit - unit for the float value

FloatPosition

public FloatPosition(double value,
                     PositionUnit unit)

Construct FloatPosition scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

FloatPosition

public FloatPosition(FloatPosition value)

Construct FloatPosition scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateAbs

public final FloatPosition instantiateAbs(float value,
                                          PositionUnit unit)

Construct a new Absolute Immutable FloatScalar of the right type. Each extending class must implement this method.

Specified by:

instantiateAbs in class AbstractFloatScalarAbs<PositionUnit,FloatPosition,LengthUnit,FloatLength>

Parameters:

value - the float value

unit - the unit

Returns:

A a new absolute instance of the FloatScalar of the right type

instantiateRel

public final FloatLength instantiateRel(float value,
                                        LengthUnit unit)

Construct a new Relative Immutable FloatScalar of the right type. Each extending class must implement this method.

Specified by:

instantiateRel in class AbstractFloatScalarAbs<PositionUnit,FloatPosition,LengthUnit,FloatLength>

Parameters:

value - the float value

unit - the unit

Returns:

R a new relative instance of the FloatScalar of the right type

createSI

public static final FloatPosition createSI(float value)

Construct FloatPosition scalar.

Parameters:

value - float value in BASE units

Returns:

the new scalar with the BASE value

interpolate

public static FloatPosition interpolate(FloatPosition zero,
                                        FloatPosition one,
                                        float ratio)

Interpolate between two values.

Parameters:

zero - the low value

one - the high value

ratio - the ratio between 0 and 1, inclusive

Returns:

a Scalar at the ratio between

max

public static FloatPosition max(FloatPosition a1,
                                FloatPosition a2)

Return the maximum value of two absolute scalars.

Parameters:

a1 - the first scalar

a2 - the second scalar

Returns:

the maximum value of two absolute scalars

max

public static FloatPosition max(FloatPosition a1,
                                FloatPosition a2,
                                FloatPosition... an)

Return the maximum value of more than two absolute scalars.

Parameters:

a1 - the first scalar

a2 - the second scalar

an - the other scalars

Returns:

the maximum value of more than two absolute scalars

min

public static FloatPosition min(FloatPosition a1,
                                FloatPosition a2)

Return the minimum value of two absolute scalars.

Parameters:

a1 - the first scalar

a2 - the second scalar

Returns:

the minimum value of two absolute scalars

min

public static FloatPosition min(FloatPosition a1,
                                FloatPosition a2,
                                FloatPosition... an)

Return the minimum value of more than two absolute scalars.

Parameters:

a1 - the first scalar

a2 - the second scalar

an - the other scalars

Returns:

the minimum value of more than two absolute scalars