Package org.djunits.value.vdouble.scalar
Class Length
java.lang.Object
java.lang.Number
org.djunits.value.base.Scalar<U,S>
org.djunits.value.vdouble.scalar.base.DoubleScalar<U,R>
org.djunits.value.vdouble.scalar.base.DoubleScalarRel<RU,R>
org.djunits.value.vdouble.scalar.base.DoubleScalarRelWithAbs<PositionUnit,Position,LengthUnit,Length>
org.djunits.value.vdouble.scalar.Length
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable<Length>
,Relative<LengthUnit,
,Length> RelWithAbs<PositionUnit,
,Position, LengthUnit, Length> Value<LengthUnit,
Length>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
date="2023-07-23T14:06:38.224104100Z")
public class Length
extends DoubleScalarRelWithAbs<PositionUnit,Position,LengthUnit,Length>
Easy access methods for the Relative Length DoubleScalar.
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:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Length
Constant with value NaN.static final Length
Constant with value -MAX_VALUE.static final Length
Constant with value NEGATIVE_INFINITY.static final Length
Constant with value one.static final Length
Constant with value MAX_VALUE.static final Length
Constant with value POSITIVE_INFINITY.static final Length
Constant with value zero.Fields inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar
si
-
Constructor Summary
ConstructorDescriptionLength
(double value, LengthUnit unit) Construct Length scalar.Construct Length scalar. -
Method Summary
Modifier and TypeMethodDescriptionfinal LinearDensity
Calculate the division of Length and Area, which results in a LinearDensity scalar.final Speed
Calculate the division of Length and Duration, which results in a Speed scalar.final Dimensionless
Calculate the division of Length and Length, which results in a Dimensionless scalar.final Area
Calculate the division of Length and LinearDensity, which results in a Area scalar.final Duration
Calculate the division of Length and Speed, which results in a Duration scalar.final Position
instantiateAbs
(double value, PositionUnit unit) Construct a new Absolute Immutable DoubleScalar of the right type.final Length
instantiateRel
(double value, LengthUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.static final Length
instantiateSI
(double value) Construct Length scalar.static Length
interpolate
(Length zero, Length one, double ratio) Interpolate between two values.static Length
Return the maximum value of two relative scalars.static Length
Return the maximum value of more than two relative scalars.static Length
Return the minimum value of two relative scalars.static Length
Return the minimum value of more than two relative scalars.static Length
Returns a Length based on a value and the textual representation of the unit, which can be localized.Create the reciprocal of this scalar with the correct dimensions.final Volume
Calculate the multiplication of Length and Area, which results in a Volume scalar.final Momentum
Calculate the multiplication of Length and FlowMass, which results in a Momentum scalar.final Energy
Calculate the multiplication of Length and Force, which results in a Energy scalar.final Speed
Calculate the multiplication of Length and Frequency, which results in a Speed scalar.final Area
Calculate the multiplication of Length and Length, which results in a Area scalar.final Dimensionless
Calculate the multiplication of Length and LinearDensity, which results in a Dimensionless scalar.static Length
Returns a Length representation of a textual representation of a value with a unit.Methods inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalarRelWithAbs
plus
Methods inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalarRel
abs, ceil, divide, divide, divide, floor, minus, neg, plus, rint, times, times, times
Methods inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar
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
Constant with value zero. -
ONE
Constant with value one. -
NaN
Constant with value NaN. -
POSITIVE_INFINITY
Constant with value POSITIVE_INFINITY. -
NEGATIVE_INFINITY
Constant with value NEGATIVE_INFINITY. -
POS_MAXVALUE
Constant with value MAX_VALUE. -
NEG_MAXVALUE
Constant with value -MAX_VALUE.
-
-
Constructor Details
-
Length
Construct Length scalar.- Parameters:
value
- double; double valueunit
- LengthUnit; unit for the double value
-
Length
Construct Length scalar.- Parameters:
value
- Length; Scalar from which to construct this instance
-
-
Method Details
-
instantiateRel
Description copied from class:DoubleScalarRel
Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.- Specified by:
instantiateRel
in classDoubleScalarRel<LengthUnit,
Length> - Parameters:
value
- double; the double valueunit
- U; the unit- Returns:
- R a new relative instance of the DoubleScalar of the right type
-
instantiateAbs
Description copied from class:DoubleScalarRelWithAbs
Construct a new Absolute Immutable DoubleScalar of the right type. Each extending class must implement this method.- Specified by:
instantiateAbs
in classDoubleScalarRelWithAbs<PositionUnit,
Position, LengthUnit, Length> - Parameters:
value
- double; the double valueunit
- AU; the absolute unit- Returns:
- A a new absolute instance of the DoubleScalar of the right type
-
instantiateSI
Construct Length scalar.- Parameters:
value
- double; the double value in SI units- Returns:
- Length; the new scalar with the SI value
-
interpolate
Interpolate between two values.- Parameters:
zero
- Length; the low valueone
- Length; the high valueratio
- double; the ratio between 0 and 1, inclusive- Returns:
- Length; a Scalar at the ratio between
-
max
Return the maximum value of two relative scalars.- Parameters:
r1
- Length; the first scalarr2
- Length; the second scalar- Returns:
- Length; the maximum value of two relative scalars
-
max
Return the maximum value of more than two relative scalars.- Parameters:
r1
- Length; the first scalarr2
- Length; the second scalarrn
- Length...; the other scalars- Returns:
- Length; the maximum value of more than two relative scalars
-
min
Return the minimum value of two relative scalars.- Parameters:
r1
- Length; the first scalarr2
- Length; the second scalar- Returns:
- Length; the minimum value of two relative scalars
-
min
Return the minimum value of more than two relative scalars.- Parameters:
r1
- Length; the first scalarr2
- Length; the second scalarrn
- Length...; the other scalars- Returns:
- Length; the minimum value of more than two relative scalars
-
valueOf
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 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 Length- Returns:
- Length; the Scalar representation of the value in its unit
- Throws:
IllegalArgumentException
- when the text cannot be parsedNullPointerException
- when the text argument is null
-
of
Returns a Length based on a value and the textual representation of the unit, which can be localized.- Parameters:
value
- double; the value to useunitString
- String; the textual representation of the unit- Returns:
- Length; the Scalar representation of the value in its unit
- Throws:
IllegalArgumentException
- when the unit cannot be parsed or is incorrectNullPointerException
- when the unitString argument is null
-
divide
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
-
times
Calculate the multiplication of Length and LinearDensity, which results in a Dimensionless scalar.- Parameters:
v
- Length; scalar- Returns:
- Dimensionless; scalar as a multiplication of Length and LinearDensity
-
times
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
-
divide
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
-
divide
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
-
times
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
-
times
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
-
times
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
-
divide
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
-
divide
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
-
times
Calculate the multiplication of Length and FlowMass, which results in a Momentum scalar.- Parameters:
v
- Length; scalar- Returns:
- Momentum; scalar as a multiplication of Length and FlowMass
-
reciprocal
Description copied from class:DoubleScalarRel
Create the reciprocal of this scalar with the correct dimensions.- Specified by:
reciprocal
in classDoubleScalarRel<LengthUnit,
Length> - Returns:
- DoubleScalar<?>; a new scalar instance with correct SI dimensions
-