org.djunits.value.vfloat.scalar

Class FloatAngle

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

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

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

org.djunits.value.vfloat.scalar.TypedFloatScalarRel<AngleUnit,FloatAngle>

org.djunits.value.vfloat.scalar.FloatAngle

All Implemented Interfaces:

Serializable, Comparable<FloatScalar.Rel<AngleUnit>>, MathFunctionsAbs<FloatScalar.Rel<AngleUnit>>, MathFunctionsRel<FloatScalar.Rel<AngleUnit>>, Relative, Value<AngleUnit>, FloatMathFunctions<FloatScalar<AngleUnit>>

public class FloatAngle
extends TypedFloatScalarRel<AngleUnit,FloatAngle>

Easy access methods for the %Type% FloatScalar. Instead of:

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

we can now write:

 FloatAngle value = new FloatAngle(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: 2015-12-22 04:32:39 +0100 (Tue, 22 Dec 2015) $, @version $Revision: 180 $, 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 FloatAngle	ZERO constant with value zero.

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

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
FloatAngle(double value, AngleUnit unit) Construct FloatAngle scalar using a double value.
FloatAngle(FloatAngle value) Construct FloatAngle scalar.
FloatAngle(float value, AngleUnit unit) Construct FloatAngle scalar.

Method Summary

Modifier and Type	Method and Description
FloatDimensionless	divideBy(FloatAngle v) Calculate the division of FloatAngle and FloatAngle, which results in a FloatDimensionless scalar.
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 FloatAngle	interpolate(FloatAngle zero, FloatAngle one, float ratio) Interpolate between two values.
static FloatAngle	max(FloatAngle r1, FloatAngle r2) Return the maximum value of two relative scalars.
static FloatAngle	max(FloatAngle r1, FloatAngle r2, FloatAngle... rn) Return the maximum value of more than two relative scalars.
static FloatAngle	min(FloatAngle r1, FloatAngle r2) Return the minimum value of two relative scalars.
static FloatAngle	min(FloatAngle r1, FloatAngle r2, FloatAngle... rn) Return the minimum value of more than two relative scalars.
FloatDirection	plus(FloatDirection v) Relative scalar plus Absolute scalar = Absolute scalar.
FloatDirection	toAbs() Translate the relative scalar into an absolute scalar (e.g., before or after a multiplication or division).

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

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

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

compareTo, eq, ge, getSI, gt, le, lt, minus, 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 FloatAngle ZERO

constant with value zero.

Constructor Detail

FloatAngle

public FloatAngle(float value,
                  AngleUnit unit)

Construct FloatAngle scalar.

Parameters:

value - float value

unit - unit for the float value

FloatAngle

public FloatAngle(FloatAngle value)

Construct FloatAngle scalar.

Parameters:

value - Scalar from which to construct this instance

FloatAngle

public FloatAngle(double value,
                  AngleUnit unit)

Construct FloatAngle scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

Method Detail

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 TypedFloatScalarRel<AngleUnit,FloatAngle>

Parameters:

value - the float value

unit - the unit

Returns:

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

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.

Parameters:

value - the float value

unit - the unit

Returns:

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

interpolate

public static FloatAngle interpolate(FloatAngle zero,
                                     FloatAngle 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

plus

public final FloatDirection plus(FloatDirection v)

Relative scalar plus Absolute scalar = Absolute scalar.

Parameters:

v - the value to add

Returns:

sum of this value and v as a new object

toAbs

public final FloatDirection toAbs()

Translate the relative scalar into an absolute scalar (e.g., before or after a multiplication or division).

Returns:

an absolute version of this angle scalar.

max

public static FloatAngle max(FloatAngle r1,
                             FloatAngle r2)

Return the maximum value of two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

Returns:

the maximum value of two relative scalars

max

public static FloatAngle max(FloatAngle r1,
                             FloatAngle r2,
                             FloatAngle... rn)

Return the maximum value of more than two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

rn - the other scalars

Returns:

the maximum value of more than two relative scalars

min

public static FloatAngle min(FloatAngle r1,
                             FloatAngle r2)

Return the minimum value of two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

Returns:

the minimum value of two relative scalars

min

public static FloatAngle min(FloatAngle r1,
                             FloatAngle r2,
                             FloatAngle... rn)

Return the minimum value of more than two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

rn - the other scalars

Returns:

the minimum value of more than two relative scalars

divideBy

public final FloatDimensionless divideBy(FloatAngle v)

Calculate the division of FloatAngle and FloatAngle, which results in a FloatDimensionless scalar.

Parameters:

v - FloatAngle scalar

Returns:

FloatDimensionless scalar as a division of FloatAngle and FloatAngle