org.djunits.value.vfloat.scalar

Class FloatDirection

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vfloat.scalar.FloatScalar<U>

org.djunits.value.vfloat.scalar.FloatScalar.Abs<U>

org.djunits.value.vfloat.scalar.TypedFloatScalarAbs<AngleUnit,FloatDirection,FloatAngle>

org.djunits.value.vfloat.scalar.FloatDirection

All Implemented Interfaces:

Serializable, Comparable<FloatScalar.Abs<AngleUnit>>, Absolute, MathFunctionsAbs<FloatScalar.Abs<AngleUnit>>, Value<AngleUnit>, FloatMathFunctions<FloatScalar<AngleUnit>>

public class FloatDirection
extends TypedFloatScalarAbs<AngleUnit,FloatDirection,FloatAngle>

Easy access methods for the Direction FloatScalar. Instead of:

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

we can now write:

 FloatDirection value = new FloatDirection(100.0, AngleUnit.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-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands.
All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2016-04-23 21:28:04 +0200 (Sat, 23 Apr 2016) $, @version $Revision: 191 $, by $Author: averbraeck $, initial version Sep 1, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.djunits.value.vfloat.scalar.FloatScalar

FloatScalar.Abs<U extends Unit<U>>, FloatScalar.Rel<U extends Unit<U>>

Field Summary

Fields

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

Fields inherited from class org.djunits.value.vfloat.scalar.FloatScalar.Abs

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, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH, TO_DEGREES, TO_RADIANS

Constructor Summary

Constructors

Constructor and Description
FloatDirection(double value, AngleUnit unit) Construct FloatDirection scalar using a double value.
FloatDirection(float value, AngleUnit unit) Construct FloatDirection scalar.
FloatDirection(FloatDirection value) Construct FloatDirection scalar.

Method Summary

Modifier and Type	Method and Description
protected FloatDirection	instantiateTypeAbs(float value, AngleUnit unit) Construct a new Absolute Immutable FloatScalar of the right type.
protected FloatAngle	instantiateTypeRel(float value, AngleUnit unit) Construct a new Relative Immutable FloatScalar of the right type.
static FloatDirection	interpolate(FloatDirection zero, FloatDirection one, float ratio) Interpolate between two values.
static FloatDirection	max(FloatDirection a1, FloatDirection a2) Return the maximum value of two absolute scalars.
static FloatDirection	max(FloatDirection a1, FloatDirection a2, FloatDirection... an) Return the maximum value of more than two absolute scalars.
static FloatDirection	min(FloatDirection a1, FloatDirection a2) Return the minimum value of two absolute scalars.
static FloatDirection	min(FloatDirection a1, FloatDirection a2, FloatDirection... an) Return the minimum value of more than two absolute scalars.

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

ceil, floor, minus, minus, plus, rint, round, toRel

Methods inherited from class org.djunits.value.vfloat.scalar.FloatScalar.Abs

compareTo, divideBy, eq, ge, getSI, gt, le, lt, minus, minus, multiplyBy, ne, plus

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

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

DIV, MULT, POW

Field Detail

ZERO

public static final FloatDirection ZERO

constant with value zero.

Constructor Detail

FloatDirection

public FloatDirection(float value,
                      AngleUnit unit)

Construct FloatDirection scalar.

Parameters:

value - float value

unit - unit for the float value

FloatDirection

public FloatDirection(double value,
                      AngleUnit unit)

Construct FloatDirection scalar using a double value.

Parameters:

value - float value

unit - unit for the float value

FloatDirection

public FloatDirection(FloatDirection value)

Construct FloatDirection scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateTypeAbs

protected final FloatDirection instantiateTypeAbs(float value,
                                                  AngleUnit unit)

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

Specified by:

instantiateTypeAbs in class TypedFloatScalarAbs<AngleUnit,FloatDirection,FloatAngle>

Parameters:

value - the float value

unit - the unit

Returns:

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

instantiateTypeRel

protected final FloatAngle instantiateTypeRel(float value,
                                              AngleUnit unit)

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

Specified by:

instantiateTypeRel in class TypedFloatScalarAbs<AngleUnit,FloatDirection,FloatAngle>

Parameters:

value - the float value

unit - the unit

Returns:

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

interpolate

public static FloatDirection interpolate(FloatDirection zero,
                                         FloatDirection 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 FloatDirection max(FloatDirection a1,
                                 FloatDirection 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 FloatDirection max(FloatDirection a1,
                                 FloatDirection a2,
                                 FloatDirection... 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 FloatDirection min(FloatDirection a1,
                                 FloatDirection 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 FloatDirection min(FloatDirection a1,
                                 FloatDirection a2,
                                 FloatDirection... 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