Package org.djunits.value.vfloat.scalar
Class FloatPosition
java.lang.Object
java.lang.Number
org.djunits.value.base.Scalar<U,S>
org.djunits.value.vfloat.scalar.base.FloatScalar<AU,A>
org.djunits.value.vfloat.scalar.base.FloatScalarAbs<PositionUnit,FloatPosition,LengthUnit,FloatLength>
org.djunits.value.vfloat.scalar.FloatPosition
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable<FloatPosition>
,Absolute<PositionUnit,
,FloatPosition, LengthUnit, FloatLength> Value<PositionUnit,
FloatPosition>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
date="2023-07-23T14:06:38.224104100Z")
public class FloatPosition
extends FloatScalarAbs<PositionUnit,FloatPosition,LengthUnit,FloatLength>
Easy access methods for the FloatPosition 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:
-
Field Summary
Fields inherited from class org.djunits.value.vfloat.scalar.base.FloatScalar
si
-
Constructor Summary
ConstructorDescriptionFloatPosition
(double value, PositionUnit unit) Construct FloatPosition scalar using a double value.FloatPosition
(float value, PositionUnit unit) Construct FloatPosition scalar.FloatPosition
(FloatPosition value) Construct FloatPosition scalar. -
Method Summary
Modifier and TypeMethodDescriptionfinal 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 FloatPosition
instantiateSI
(float value) Construct FloatPosition scalar.static FloatPosition
interpolate
(FloatPosition zero, FloatPosition one, float ratio) Interpolate between two values.static FloatPosition
max
(FloatPosition a1, FloatPosition a2) Return the maximum value of two absolute scalars.static FloatPosition
max
(FloatPosition a1, FloatPosition a2, FloatPosition... an) Return the maximum value of more than two absolute scalars.static FloatPosition
min
(FloatPosition a1, FloatPosition a2) Return the minimum value of two absolute scalars.static FloatPosition
min
(FloatPosition a1, FloatPosition a2, FloatPosition... an) Return the minimum value of more than two absolute scalars.static FloatPosition
Returns a FloatPosition based on a value and the textual representation of the unit, which can be localized.static FloatPosition
Returns a FloatPosition representation of a textual representation of a value with a unit.Methods inherited from class org.djunits.value.vfloat.scalar.base.FloatScalarAbs
abs, ceil, floor, minus, minus, neg, plus, rint
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.Value
isAbsolute, isRelative
-
Field Details
-
ZERO
Constant with value zero.
-
-
Constructor Details
-
FloatPosition
Construct FloatPosition scalar.- Parameters:
value
- float; the float valueunit
- PositionUnit; unit for the float value
-
FloatPosition
Construct FloatPosition scalar using a double value.- Parameters:
value
- double; the double valueunit
- PositionUnit; unit for the resulting float value
-
FloatPosition
Construct FloatPosition scalar.- Parameters:
value
- FloatPosition; Scalar from which to construct this instance
-
-
Method Details
-
instantiateAbs
Description copied from class:FloatScalarAbs
Construct a new Absolute Immutable FloatScalar of the right type. Each extending class must implement this method.- Specified by:
instantiateAbs
in classFloatScalarAbs<PositionUnit,
FloatPosition, LengthUnit, FloatLength> - Parameters:
value
- float; the float valueunit
- AU; the absolute unit- Returns:
- A a new absolute instance of the FloatScalar of the right type
-
instantiateRel
Description copied from class:FloatScalarAbs
Construct a new Relative Immutable FloatScalar of the right type. Each extending class must implement this method.- Specified by:
instantiateRel
in classFloatScalarAbs<PositionUnit,
FloatPosition, LengthUnit, FloatLength> - Parameters:
value
- float; the float valueunit
- RU; the unit- Returns:
- R a new relative instance of the FloatScalar of the right type
-
instantiateSI
Construct FloatPosition scalar.- Parameters:
value
- float; the float value in BASE units- Returns:
- FloatPosition; the new scalar with the BASE value
-
interpolate
Interpolate between two values.- Parameters:
zero
- FloatPosition; the low valueone
- FloatPosition; the high valueratio
- float; the ratio between 0 and 1, inclusive- Returns:
- FloatPosition; a Scalar at the ratio between
-
max
Return the maximum value of two absolute scalars.- Parameters:
a1
- FloatPosition; the first scalara2
- FloatPosition; the second scalar- Returns:
- FloatPosition; the maximum value of two absolute scalars
-
max
Return the maximum value of more than two absolute scalars.- Parameters:
a1
- FloatPosition; the first scalara2
- FloatPosition; the second scalaran
- FloatPosition...; the other scalars- Returns:
- FloatPosition; the maximum value of more than two absolute scalars
-
min
Return the minimum value of two absolute scalars.- Parameters:
a1
- FloatPosition; the first scalara2
- FloatPosition; the second scalar- Returns:
- FloatPosition; the minimum value of two absolute scalars
-
min
Return the minimum value of more than two absolute scalars.- Parameters:
a1
- FloatPosition; the first scalara2
- FloatPosition; the second scalaran
- FloatPosition...; the other scalars- Returns:
- FloatPosition; the minimum value of more than two absolute scalars
-
valueOf
Returns a FloatPosition 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 FloatPosition- Returns:
- FloatPosition; 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 FloatPosition 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:
- FloatPosition; 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
-