org.djunits.value.vfloat.scalar

Class FloatLength

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<LengthUnit,FloatLength>

org.djunits.value.vfloat.scalar.FloatLength

All Implemented Interfaces:

Serializable, Comparable<FloatLength>, MathFunctionsAbs<FloatLength>, MathFunctionsRel<FloatLength>, Relative, Value<LengthUnit>, FloatMathFunctions<FloatLength>, FloatScalarInterface

public class FloatLength
extends AbstractFloatScalarRel<LengthUnit,FloatLength>

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

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

we can now write:

 FloatLength value = new FloatLength(100.0, LengthUnit.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: 2019-03-03 00:53:50 +0100 (Sun, 03 Mar 2019) $, @version $Revision: 349 $, 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 FloatLength	NaN constant with value NaN.
static FloatLength	NEG_MAXVALUE constant with value -MAX_VALUE.
static FloatLength	NEGATIVE_INFINITY constant with value NEGATIVE_INFINITY.
static FloatLength	POS_MAXVALUE constant with value MAX_VALUE.
static FloatLength	POSITIVE_INFINITY constant with value POSITIVE_INFINITY.
static FloatLength	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
FloatLength(double value, LengthUnit unit) Construct FloatLength scalar using a double value.
FloatLength(FloatLength value) Construct FloatLength scalar.
FloatLength(float value, LengthUnit unit) Construct FloatLength scalar.

Method Summary

Modifier and Type	Method and Description
static FloatLength	createSI(float value) Construct FloatLength scalar.
FloatLinearDensity	divideBy(FloatArea v) Calculate the division of FloatLength and FloatArea, which results in a FloatLinearDensity scalar.
FloatSpeed	divideBy(FloatDuration v) Calculate the division of FloatLength and FloatDuration, which results in a FloatSpeed scalar.
FloatDimensionless	divideBy(FloatLength v) Calculate the division of FloatLength and FloatLength, which results in a FloatDimensionless scalar.
FloatArea	divideBy(FloatLinearDensity v) Calculate the division of FloatLength and FloatLinearDensity, which results in a FloatArea scalar.
FloatDuration	divideBy(FloatSpeed v) Calculate the division of FloatLength and FloatSpeed, which results in a FloatDuration 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 FloatLength	interpolate(FloatLength zero, FloatLength one, float ratio) Interpolate between two values.
static FloatLength	max(FloatLength r1, FloatLength r2) Return the maximum value of two relative scalars.
static FloatLength	max(FloatLength r1, FloatLength r2, FloatLength... rn) Return the maximum value of more than two relative scalars.
static FloatLength	min(FloatLength r1, FloatLength r2) Return the minimum value of two relative scalars.
static FloatLength	min(FloatLength r1, FloatLength r2, FloatLength... rn) Return the minimum value of more than two relative scalars.
FloatVolume	multiplyBy(FloatArea v) Calculate the multiplication of FloatLength and FloatArea, which results in a FloatVolume scalar.
FloatEnergy	multiplyBy(FloatForce v) Calculate the multiplication of FloatLength and FloatForce, which results in a FloatEnergy scalar.
FloatSpeed	multiplyBy(FloatFrequency v) Calculate the multiplication of FloatLength and FloatFrequency, which results in a FloatSpeed scalar.
FloatArea	multiplyBy(FloatLength v) Calculate the multiplication of FloatLength and FloatLength, which results in a FloatArea scalar.
FloatMoney	multiplyBy(FloatMoneyPerLength v) Calculate the multiplication of FloatLength and FloatMoneyPerLength, which results in a FloatMoney scalar.
FloatPosition	plus(FloatPosition v) Relative scalar plus Absolute scalar = Absolute scalar.
static FloatLength	valueOf(String text) Returns a FloatLength 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 FloatLength ZERO

constant with value zero.

NaN

public static final FloatLength NaN

constant with value NaN.

POSITIVE_INFINITY

public static final FloatLength POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatLength NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatLength POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatLength NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

FloatLength

public FloatLength(float value,
                   LengthUnit unit)

Construct FloatLength scalar.

Parameters:

value - float value

unit - unit for the float value

FloatLength

public FloatLength(FloatLength value)

Construct FloatLength scalar.

Parameters:

value - Scalar from which to construct this instance

FloatLength

public FloatLength(double value,
                   LengthUnit unit)

Construct FloatLength scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

Method Detail

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 AbstractFloatScalarRel<LengthUnit,FloatLength>

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 FloatLength createSI(float value)

Construct FloatLength scalar.

Parameters:

value - float value in SI units

Returns:

the new scalar with the SI value

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.

Parameters:

value - the float value

unit - the unit

Returns:

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

interpolate

public static FloatLength interpolate(FloatLength zero,
                                      FloatLength 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 FloatPosition plus(FloatPosition 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 FloatLength max(FloatLength r1,
                              FloatLength 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 FloatLength max(FloatLength r1,
                              FloatLength r2,
                              FloatLength... 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 FloatLength min(FloatLength r1,
                              FloatLength 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 FloatLength min(FloatLength r1,
                              FloatLength r2,
                              FloatLength... 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 FloatLength valueOf(String text)
                           throws IllegalArgumentException

Returns a FloatLength 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 FloatLength

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(FloatLength v)

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

Parameters:

v - FloatLength scalar

Returns:

FloatDimensionless scalar as a division of FloatLength and FloatLength

multiplyBy

public final FloatArea multiplyBy(FloatLength v)

Calculate the multiplication of FloatLength and FloatLength, which results in a FloatArea scalar.

Parameters:

v - FloatLength scalar

Returns:

FloatArea scalar as a multiplication of FloatLength and FloatLength

divideBy

public final FloatArea divideBy(FloatLinearDensity v)

Calculate the division of FloatLength and FloatLinearDensity, which results in a FloatArea scalar.

Parameters:

v - FloatLength scalar

Returns:

FloatArea scalar as a division of FloatLength and FloatLinearDensity

divideBy

public final FloatLinearDensity divideBy(FloatArea v)

Calculate the division of FloatLength and FloatArea, which results in a FloatLinearDensity scalar.

Parameters:

v - FloatLength scalar

Returns:

FloatLinearDensity scalar as a division of FloatLength and FloatArea

multiplyBy

public final FloatVolume multiplyBy(FloatArea v)

Calculate the multiplication of FloatLength and FloatArea, which results in a FloatVolume scalar.

Parameters:

v - FloatLength scalar

Returns:

FloatVolume scalar as a multiplication of FloatLength and FloatArea

multiplyBy

public final FloatEnergy multiplyBy(FloatForce v)

Calculate the multiplication of FloatLength and FloatForce, which results in a FloatEnergy scalar.

Parameters:

v - FloatLength scalar

Returns:

FloatEnergy scalar as a multiplication of FloatLength and FloatForce

multiplyBy

public final FloatSpeed multiplyBy(FloatFrequency v)

Calculate the multiplication of FloatLength and FloatFrequency, which results in a FloatSpeed scalar.

Parameters:

v - FloatLength scalar

Returns:

FloatSpeed scalar as a multiplication of FloatLength and FloatFrequency

divideBy

public final FloatSpeed divideBy(FloatDuration v)

Calculate the division of FloatLength and FloatDuration, which results in a FloatSpeed scalar.

Parameters:

v - FloatLength scalar

Returns:

FloatSpeed scalar as a division of FloatLength and FloatDuration

divideBy

public final FloatDuration divideBy(FloatSpeed v)

Calculate the division of FloatLength and FloatSpeed, which results in a FloatDuration scalar.

Parameters:

v - FloatLength scalar

Returns:

FloatDuration scalar as a division of FloatLength and FloatSpeed

multiplyBy

public final FloatMoney multiplyBy(FloatMoneyPerLength v)

Calculate the multiplication of FloatLength and FloatMoneyPerLength, which results in a FloatMoney scalar.

Parameters:

v - FloatLength scalar

Returns:

FloatMoney scalar as a multiplication of FloatLength and FloatMoneyPerLength