Package org.djunits.value.vfloat.scalar
Class FloatTemperature
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<AbsoluteTemperatureUnit,FloatAbsoluteTemperature,TemperatureUnit,FloatTemperature>
org.djunits.value.vfloat.scalar.FloatTemperature
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable<FloatTemperature>
,Relative<TemperatureUnit,
,FloatTemperature> RelWithAbs<AbsoluteTemperatureUnit,
,FloatAbsoluteTemperature, TemperatureUnit, FloatTemperature> Value<TemperatureUnit,
FloatTemperature>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
date="2023-07-23T14:06:38.224104100Z")
public class FloatTemperature
extends FloatScalarRelWithAbs<AbsoluteTemperatureUnit,FloatAbsoluteTemperature,TemperatureUnit,FloatTemperature>
Easy access methods for the FloatTemperature 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
Modifier and TypeFieldDescriptionstatic final FloatTemperature
Constant with value NaN.static final FloatTemperature
Constant with value -MAX_VALUE.static final FloatTemperature
Constant with value NEGATIVE_INFINITY.static final FloatTemperature
Constant with value one.static final FloatTemperature
Constant with value MAX_VALUE.static final FloatTemperature
Constant with value POSITIVE_INFINITY.static final FloatTemperature
Constant with value zero.Fields inherited from class org.djunits.value.vfloat.scalar.base.FloatScalar
si
-
Constructor Summary
ConstructorDescriptionFloatTemperature
(double value, TemperatureUnit unit) Construct FloatTemperature scalar using a double value.FloatTemperature
(float value, TemperatureUnit unit) Construct FloatTemperature scalar.FloatTemperature
(FloatTemperature value) Construct FloatTemperature scalar. -
Method Summary
Modifier and TypeMethodDescriptionfinal FloatDimensionless
Calculate the division of FloatTemperature and FloatTemperature, which results in a FloatDimensionless scalar.final FloatAbsoluteTemperature
instantiateAbs
(float value, AbsoluteTemperatureUnit unit) Construct a new Absolute Immutable FloatScalar of the right type.final FloatTemperature
instantiateRel
(float value, TemperatureUnit unit) Construct a new Relative Immutable FloatScalar of the right type.static final FloatTemperature
instantiateSI
(float value) Construct FloatTemperature scalar.static FloatTemperature
interpolate
(FloatTemperature zero, FloatTemperature one, float ratio) Interpolate between two values.static FloatTemperature
max
(FloatTemperature r1, FloatTemperature r2) Return the maximum value of two relative scalars.static FloatTemperature
max
(FloatTemperature r1, FloatTemperature r2, FloatTemperature... rn) Return the maximum value of more than two relative scalars.static FloatTemperature
min
(FloatTemperature r1, FloatTemperature r2) Return the minimum value of two relative scalars.static FloatTemperature
min
(FloatTemperature r1, FloatTemperature r2, FloatTemperature... rn) Return the minimum value of more than two relative scalars.static FloatTemperature
Returns a FloatTemperature 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.static FloatTemperature
Returns a FloatTemperature 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
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
-
FloatTemperature
Construct FloatTemperature scalar.- Parameters:
value
- float; the float valueunit
- TemperatureUnit; unit for the float value
-
FloatTemperature
Construct FloatTemperature scalar.- Parameters:
value
- FloatTemperature; Scalar from which to construct this instance
-
FloatTemperature
Construct FloatTemperature scalar using a double value.- Parameters:
value
- double; the double valueunit
- TemperatureUnit; unit for the resulting float value
-
-
Method Details
-
instantiateRel
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 classFloatScalarRel<TemperatureUnit,
FloatTemperature> - Parameters:
value
- float; the float valueunit
- U; the unit- Returns:
- R a new relative instance of the FloatScalar of the right type
-
instantiateSI
Construct FloatTemperature scalar.- Parameters:
value
- float; the float value in SI units- Returns:
- FloatTemperature; the new scalar with the SI value
-
instantiateAbs
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 classFloatScalarRelWithAbs<AbsoluteTemperatureUnit,
FloatAbsoluteTemperature, TemperatureUnit, FloatTemperature> - Parameters:
value
- float; the float valueunit
- AU; the absolute unit- Returns:
- A a new absolute instance of the FloatScalar of the right type
-
interpolate
public static FloatTemperature interpolate(FloatTemperature zero, FloatTemperature one, float ratio) Interpolate between two values.- Parameters:
zero
- FloatTemperature; the low valueone
- FloatTemperature; the high valueratio
- double; the ratio between 0 and 1, inclusive- Returns:
- FloatTemperature; a Scalar at the ratio between
-
max
Return the maximum value of two relative scalars.- Parameters:
r1
- FloatTemperature; the first scalarr2
- FloatTemperature; the second scalar- Returns:
- FloatTemperature; the maximum value of two relative scalars
-
max
public static FloatTemperature max(FloatTemperature r1, FloatTemperature r2, FloatTemperature... rn) Return the maximum value of more than two relative scalars.- Parameters:
r1
- FloatTemperature; the first scalarr2
- FloatTemperature; the second scalarrn
- FloatTemperature...; the other scalars- Returns:
- FloatTemperature; the maximum value of more than two relative scalars
-
min
Return the minimum value of two relative scalars.- Parameters:
r1
- FloatTemperature; the first scalarr2
- FloatTemperature; the second scalar- Returns:
- FloatTemperature; the minimum value of two relative scalars
-
min
public static FloatTemperature min(FloatTemperature r1, FloatTemperature r2, FloatTemperature... rn) Return the minimum value of more than two relative scalars.- Parameters:
r1
- FloatTemperature; the first scalarr2
- FloatTemperature; the second scalarrn
- FloatTemperature...; the other scalars- Returns:
- FloatTemperature; the minimum value of more than two relative scalars
-
valueOf
Returns a FloatTemperature 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 FloatTemperature- Returns:
- FloatTemperature; 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 FloatTemperature 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:
- FloatTemperature; 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 FloatTemperature and FloatTemperature, which results in a FloatDimensionless scalar.- Parameters:
v
- FloatTemperature; scalar- Returns:
- FloatDimensionless; scalar as a division of FloatTemperature and FloatTemperature
-
reciprocal
Description copied from class:FloatScalarRel
Create the reciprocal of this scalar with the correct dimensions.- Specified by:
reciprocal
in classFloatScalarRel<TemperatureUnit,
FloatTemperature> - Returns:
- FloatScalar<?>; a new scalar instance with correct SI dimensions
-