Package org.djunits.value.vfloat.scalar

Class FloatLength

java.lang.Object

java.lang.Number

org.djunits.value.base.Scalar<U,S>

org.djunits.value.vfloat.scalar.base.FloatScalar<U,R>

org.djunits.value.vfloat.scalar.base.FloatScalarRel<RU,R>

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

org.djunits.value.vfloat.scalar.FloatLength

All Implemented Interfaces:

Serializable, Cloneable, Comparable<FloatLength>, Relative<LengthUnit,FloatLength>, RelWithAbs<PositionUnit,FloatPosition,LengthUnit,FloatLength>, Value<LengthUnit,FloatLength>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-07-23T14:06:38.224104100Z")
public class FloatLength
extends FloatScalarRelWithAbs<PositionUnit,FloatPosition,LengthUnit,FloatLength>

Easy access methods for the FloatLength FloatScalar.

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

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final FloatLength	NaN	Constant with value NaN.
static final FloatLength	NEG_MAXVALUE	Constant with value -MAX_VALUE.
static final FloatLength	NEGATIVE_INFINITY	Constant with value NEGATIVE_INFINITY.
static final FloatLength	ONE	Constant with value one.
static final FloatLength	POS_MAXVALUE	Constant with value MAX_VALUE.
static final FloatLength	POSITIVE_INFINITY	Constant with value POSITIVE_INFINITY.
static final FloatLength	ZERO	Constant with value zero.

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

si

Constructor Summary

Constructors

Constructor	Description
FloatLength(double value, LengthUnit unit)	Construct FloatLength scalar using a double value.
FloatLength(float value, LengthUnit unit)	Construct FloatLength scalar.
FloatLength(FloatLength value)	Construct FloatLength scalar.

Method Summary

Modifier and Type	Method	Description
final FloatLinearDensity	divide(FloatArea v)	Calculate the division of FloatLength and FloatArea, which results in a FloatLinearDensity scalar.
final FloatSpeed	divide(FloatDuration v)	Calculate the division of FloatLength and FloatDuration, which results in a FloatSpeed scalar.
final FloatDimensionless	divide(FloatLength v)	Calculate the division of FloatLength and FloatLength, which results in a FloatDimensionless scalar.
final FloatArea	divide(FloatLinearDensity v)	Calculate the division of FloatLength and FloatLinearDensity, which results in a FloatArea scalar.
final FloatDuration	divide(FloatSpeed v)	Calculate the division of FloatLength and FloatSpeed, which results in a FloatDuration scalar.
final FloatPosition	instantiateAbs(float value, PositionUnit unit)	Construct a new Absolute Immutable FloatScalar of the right type.
final FloatLength	instantiateRel(float value, LengthUnit unit)	Construct a new Relative Immutable FloatScalar of the right type.
static final FloatLength	instantiateSI(float value)	Construct FloatLength scalar.
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.
static FloatLength	of(float value, String unitString)	Returns a FloatLength based on a value and the textual representation of the unit, which can be localized.
FloatLinearDensity	reciprocal()	Create the reciprocal of this scalar with the correct dimensions.
final FloatVolume	times(FloatArea v)	Calculate the multiplication of FloatLength and FloatArea, which results in a FloatVolume scalar.
final FloatMomentum	times(FloatFlowMass v)	Calculate the multiplication of FloatLength and FloatFlowMass, which results in a FloatMomentum scalar.
final FloatEnergy	times(FloatForce v)	Calculate the multiplication of FloatLength and FloatForce, which results in a FloatEnergy scalar.
final FloatSpeed	times(FloatFrequency v)	Calculate the multiplication of FloatLength and FloatFrequency, which results in a FloatSpeed scalar.
final FloatArea	times(FloatLength v)	Calculate the multiplication of FloatLength and FloatLength, which results in a FloatArea scalar.
final FloatDimensionless	times(FloatLinearDensity v)	Calculate the multiplication of FloatLength and FloatLinearDensity, which results in a FloatDimensionless 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.base.FloatScalarRelWithAbs

plus

Methods inherited from class org.djunits.value.vfloat.scalar.base.FloatScalarRel

abs, ceil, divide, divide, divide, floor, minus, neg, plus, rint, times, times, times

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

compareTo, divide, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, instantiate, instantiateAnonymous, instantiateSI, interpolate, interpolate, intValue, le, le0, longValue, lt, lt0, max, max, min, min, minus, minus, minus, multiply, ne, ne0, plus, plus, plus, toDisplayString, toDisplayString, toString, toString, toString, toString, toStringSIPrefixed, toStringSIPrefixed, toTextualString, toTextualString

Methods inherited from class org.djunits.value.base.Scalar

format, format, getDisplayUnit, 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.Relative

divide, divide, minus, plus, times, times

Methods inherited from interface org.djunits.value.Value

isAbsolute, isRelative

Field Details

ZERO

public static final FloatLength ZERO

Constant with value zero.

ONE

public static final FloatLength ONE

Constant with value one.

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 Details

FloatLength

public FloatLength(float value,
 LengthUnit unit)

Construct FloatLength scalar.

Parameters:

value - float; the float value

unit - LengthUnit; unit for the float value

FloatLength

public FloatLength(FloatLength value)

Construct FloatLength scalar.

Parameters:

value - FloatLength; Scalar from which to construct this instance

FloatLength

public FloatLength(double value,
 LengthUnit unit)

Construct FloatLength scalar using a double value.

Parameters:

value - double; the double value

unit - LengthUnit; unit for the resulting float value

Method Details

instantiateRel

public final FloatLength instantiateRel(float value,
 LengthUnit unit)

Description copied from class: FloatScalarRel

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

Specified by:

instantiateRel in class FloatScalarRel<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

instantiateSI

public static final FloatLength instantiateSI(float value)

Construct FloatLength scalar.

Parameters:

value - float; the float value in SI units

Returns:

FloatLength; the new scalar with the SI value

instantiateAbs

public final FloatPosition instantiateAbs(float value,
 PositionUnit unit)

Description copied from class: FloatScalarRelWithAbs

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

Specified by:

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

Parameters:

value - float; the float value

unit - AU; the absolute 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 - FloatLength; the low value

one - FloatLength; the high value

ratio - double; the ratio between 0 and 1, inclusive

Returns:

FloatLength; a Scalar at the ratio between

max

public static FloatLength max(FloatLength r1,
 FloatLength r2)

Return the maximum value of two relative scalars.

Parameters:

r1 - FloatLength; the first scalar

r2 - FloatLength; the second scalar

Returns:

FloatLength; 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 - FloatLength; the first scalar

r2 - FloatLength; the second scalar

rn - FloatLength...; the other scalars

Returns:

FloatLength; 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 - FloatLength; the first scalar

r2 - FloatLength; the second scalar

Returns:

FloatLength; 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 - FloatLength; the first scalar

r2 - FloatLength; the second scalar

rn - FloatLength...; the other scalars

Returns:

FloatLength; the minimum value of more than two relative scalars

valueOf

public static FloatLength valueOf(String text)

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 a localized or English abbreviation of the unit. Spaces are allowed, but not required, between the value and the unit.

Parameters:

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

Returns:

FloatLength; the Scalar representation of the value in its unit

Throws:

IllegalArgumentException - when the text cannot be parsed

NullPointerException - when the text argument is null

of

public static FloatLength of(float value,
 String unitString)

Returns a FloatLength based on a value and the textual representation of the unit, which can be localized.

Parameters:

value - double; the value to use

unitString - String; the textual representation of the unit

Returns:

FloatLength; the Scalar representation of the value in its unit

Throws:

IllegalArgumentException - when the unit cannot be parsed or is incorrect

NullPointerException - when the unitString argument is null

divide

public final FloatDimensionless divide(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

times

public final FloatDimensionless times(FloatLinearDensity v)

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

Parameters:

v - FloatLength; scalar

Returns:

FloatDimensionless; scalar as a multiplication of FloatLength and FloatLinearDensity

times

public final FloatArea times(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

divide

public final FloatArea divide(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

divide

public final FloatLinearDensity divide(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

times

public final FloatVolume times(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

times

public final FloatEnergy times(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

times

public final FloatSpeed times(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

divide

public final FloatSpeed divide(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

divide

public final FloatDuration divide(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

times

public final FloatMomentum times(FloatFlowMass v)

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

Parameters:

v - FloatLength; scalar

Returns:

FloatMomentum; scalar as a multiplication of FloatLength and FloatFlowMass

reciprocal

public FloatLinearDensity reciprocal()

Description copied from class: FloatScalarRel

Create the reciprocal of this scalar with the correct dimensions.

Specified by:

reciprocal in class FloatScalarRel<LengthUnit,FloatLength>

Returns:

FloatScalar<?>; a new scalar instance with correct SI dimensions