org.djunits.value.vfloat.scalar

Class FloatAngle

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vfloat.scalar.AbstractFloatScalar<U,R>

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

org.djunits.value.vfloat.scalar.FloatAngle

All Implemented Interfaces:

Serializable, Comparable<FloatAngle>, MathFunctionsAbs<FloatAngle>, MathFunctionsRel<FloatAngle>, Relative, Value<AngleUnit>, FloatMathFunctions<FloatAngle>, FloatScalarInterface

public class FloatAngle
extends AbstractFloatScalarRel<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-2019 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

Field Summary

Fields

Modifier and Type	Field and Description
static FloatAngle	NaN constant with value NaN.
static FloatAngle	NEG_MAXVALUE constant with value -MAX_VALUE.
static FloatAngle	NEGATIVE_INFINITY constant with value NEGATIVE_INFINITY.
static FloatAngle	POS_MAXVALUE constant with value MAX_VALUE.
static FloatAngle	POSITIVE_INFINITY constant with value POSITIVE_INFINITY.
static FloatAngle	ZERO constant with value zero.

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

si

Fields inherited from class org.djunits.value.Scalar

NUMBER_PATTERN

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
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
static FloatAngle	createSI(float value) Construct FloatAngle scalar.
FloatDimensionless	divideBy(FloatAngle v) Calculate the division of FloatAngle and FloatAngle, which results in a FloatDimensionless scalar.
FloatDirection	instantiateAbs(float value, DirectionUnit unit) Construct a new Absolute Immutable FloatScalar of the right type.
FloatAngle	instantiateRel(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.
static FloatAngle	valueOf(String text) Returns a FloatAngle representation of a textual representation of a value with a unit.

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

abs, ceil, divideBy, floor, minus, multiplyBy, neg, 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, stringOf, stringOfDefaultLocale, textualStringOf, textualStringOfDefaultLocale

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.

NaN

public static final FloatAngle NaN

constant with value NaN.

POSITIVE_INFINITY

public static final FloatAngle POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatAngle NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatAngle POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatAngle NEG_MAXVALUE

constant with value -MAX_VALUE.

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

instantiateRel

public final FloatAngle instantiateRel(float value,
                                       AngleUnit unit)

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

Specified by:

instantiateRel in class AbstractFloatScalarRel<AngleUnit,FloatAngle>

Parameters:

value - float; the float value

unit - U; the unit

Returns:

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

createSI

public static final FloatAngle createSI(float value)

Construct FloatAngle scalar.

Parameters:

value - float value in SI units

Returns:

the new scalar with the SI value

instantiateAbs

public final FloatDirection instantiateAbs(float value,
                                           DirectionUnit 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

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

valueOf

public static FloatAngle valueOf(String text)
                          throws IllegalArgumentException

Returns a FloatAngle representation of a textual representation of a value with a unit. The String representation that can be parsed is the double value in the unit, followed by the official abbreviation of the unit. Spaces are allowed, but not necessary, between the value and the unit.

Parameters:

text - String; the textual representation to parse into a FloatAngle

Returns:

the String representation of the value in its unit, followed by the official abbreviation of the unit

Throws:

IllegalArgumentException - when the text cannot be parsed

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