org.djunits.value.vdouble.scalar

Class Length

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vdouble.scalar.AbstractDoubleScalar<U,R>

org.djunits.value.vdouble.scalar.AbstractDoubleScalarRel<LengthUnit,Length>

org.djunits.value.vdouble.scalar.Length

All Implemented Interfaces:

Serializable, Comparable<Length>, MathFunctionsAbs<Length>, MathFunctionsRel<Length>, Relative, Value<LengthUnit>, DoubleMathFunctions<Length>, DoubleScalarInterface

public class Length
extends AbstractDoubleScalarRel<LengthUnit,Length>

Easy access methods for the Relative Length DoubleScalar. Instead of:

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

we can now write:

 Length value = new Length(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 Length	NaN constant with value NaN.
static Length	NEG_MAXVALUE constant with value -MAX_VALUE.
static Length	NEGATIVE_INFINITY constant with value NEGATIVE_INFINITY.
static Length	POS_MAXVALUE constant with value MAX_VALUE.
static Length	POSITIVE_INFINITY constant with value POSITIVE_INFINITY.
static Length	ZERO constant with value zero.

Fields inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalar

si

Fields inherited from class org.djunits.value.Scalar

NUMBER_PATTERN

Fields inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, NEG, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH

Constructor Summary

Constructors

Constructor and Description
Length(double value, LengthUnit unit) Construct Length scalar.
Length(Length value) Construct Length scalar.

Method Summary

Modifier and Type	Method and Description
static Length	createSI(double value) Construct Length scalar.
LinearDensity	divideBy(Area v) Calculate the division of Length and Area, which results in a LinearDensity scalar.
Speed	divideBy(Duration v) Calculate the division of Length and Duration, which results in a Speed scalar.
Dimensionless	divideBy(Length v) Calculate the division of Length and Length, which results in a Dimensionless scalar.
Area	divideBy(LinearDensity v) Calculate the division of Length and LinearDensity, which results in a Area scalar.
Duration	divideBy(Speed v) Calculate the division of Length and Speed, which results in a Duration scalar.
Position	instantiateAbs(double value, PositionUnit unit) Construct a new Absolute Immutable DoubleScalar of the right type.
Length	instantiateRel(double value, LengthUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
static Length	interpolate(Length zero, Length one, double ratio) Interpolate between two values.
static Length	max(Length r1, Length r2) Return the maximum value of two relative scalars.
static Length	max(Length r1, Length r2, Length... rn) Return the maximum value of more than two relative scalars.
static Length	min(Length r1, Length r2) Return the minimum value of two relative scalars.
static Length	min(Length r1, Length r2, Length... rn) Return the minimum value of more than two relative scalars.
Volume	multiplyBy(Area v) Calculate the multiplication of Length and Area, which results in a Volume scalar.
Energy	multiplyBy(Force v) Calculate the multiplication of Length and Force, which results in a Energy scalar.
Speed	multiplyBy(Frequency v) Calculate the multiplication of Length and Frequency, which results in a Speed scalar.
Area	multiplyBy(Length v) Calculate the multiplication of Length and Length, which results in a Area scalar.
Money	multiplyBy(MoneyPerLength v) Calculate the multiplication of Length and MoneyPerLength, which results in a Money scalar.
Position	plus(Position v) Relative scalar plus Absolute scalar = Absolute scalar.
static Length	valueOf(String text) Returns a Length representation of a textual representation of a value with a unit.

Methods inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalarRel

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

Methods inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalar

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.vdouble.DoubleMathFunctions

DIV, MULT, POW

Field Detail

ZERO

public static final Length ZERO

constant with value zero.

NaN

public static final Length NaN

constant with value NaN.

POSITIVE_INFINITY

public static final Length POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final Length NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final Length POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final Length NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

Length

public Length(double value,
              LengthUnit unit)

Construct Length scalar.

Parameters:

value - double value

unit - unit for the double value

Length

public Length(Length value)

Construct Length scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateRel

public final Length instantiateRel(double value,
                                   LengthUnit unit)

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

Specified by:

instantiateRel in class AbstractDoubleScalarRel<LengthUnit,Length>

Parameters:

value - double; the double value

unit - U; the unit

Returns:

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

instantiateAbs

public final Position instantiateAbs(double value,
                                     PositionUnit unit)

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

Parameters:

value - the double value

unit - the unit

Returns:

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

createSI

public static final Length createSI(double value)

Construct Length scalar.

Parameters:

value - double value in SI units

Returns:

the new scalar with the SI value

interpolate

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

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

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 Dimensionless divideBy(Length v)

Calculate the division of Length and Length, which results in a Dimensionless scalar.

Parameters:

v - Length scalar

Returns:

Dimensionless scalar as a division of Length and Length

multiplyBy

public final Area multiplyBy(Length v)

Calculate the multiplication of Length and Length, which results in a Area scalar.

Parameters:

v - Length scalar

Returns:

Area scalar as a multiplication of Length and Length

divideBy

public final Area divideBy(LinearDensity v)

Calculate the division of Length and LinearDensity, which results in a Area scalar.

Parameters:

v - Length scalar

Returns:

Area scalar as a division of Length and LinearDensity

divideBy

public final LinearDensity divideBy(Area v)

Calculate the division of Length and Area, which results in a LinearDensity scalar.

Parameters:

v - Length scalar

Returns:

LinearDensity scalar as a division of Length and Area

multiplyBy

public final Volume multiplyBy(Area v)

Calculate the multiplication of Length and Area, which results in a Volume scalar.

Parameters:

v - Length scalar

Returns:

Volume scalar as a multiplication of Length and Area

multiplyBy

public final Energy multiplyBy(Force v)

Calculate the multiplication of Length and Force, which results in a Energy scalar.

Parameters:

v - Length scalar

Returns:

Energy scalar as a multiplication of Length and Force

multiplyBy

public final Speed multiplyBy(Frequency v)

Calculate the multiplication of Length and Frequency, which results in a Speed scalar.

Parameters:

v - Length scalar

Returns:

Speed scalar as a multiplication of Length and Frequency

divideBy

public final Speed divideBy(Duration v)

Calculate the division of Length and Duration, which results in a Speed scalar.

Parameters:

v - Length scalar

Returns:

Speed scalar as a division of Length and Duration

divideBy

public final Duration divideBy(Speed v)

Calculate the division of Length and Speed, which results in a Duration scalar.

Parameters:

v - Length scalar

Returns:

Duration scalar as a division of Length and Speed

multiplyBy

public final Money multiplyBy(MoneyPerLength v)

Calculate the multiplication of Length and MoneyPerLength, which results in a Money scalar.

Parameters:

v - Length scalar

Returns:

Money scalar as a multiplication of Length and MoneyPerLength