Package org.djunits.value.vfloat.scalar
Class FloatTemperature
- java.lang.Object
-
- java.lang.Number
-
- org.djunits.value.AbstractScalar<U,S>
-
- org.djunits.value.vfloat.scalar.base.AbstractFloatScalar<U,R>
-
- org.djunits.value.vfloat.scalar.base.AbstractFloatScalarRel<RU,R>
-
- org.djunits.value.vfloat.scalar.base.AbstractFloatScalarRelWithAbs<AbsoluteTemperatureUnit,FloatAbsoluteTemperature,TemperatureUnit,FloatTemperature>
-
- org.djunits.value.vfloat.scalar.FloatTemperature
-
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable<FloatTemperature>
,Scalar<TemperatureUnit,FloatTemperature>
,Scalar.Rel<TemperatureUnit,FloatTemperature>
,Scalar.RelWithAbs<AbsoluteTemperatureUnit,FloatAbsoluteTemperature,TemperatureUnit,FloatTemperature>
,ValueFunctions<TemperatureUnit,FloatTemperature>
,Relative<TemperatureUnit,FloatTemperature>
,Value<TemperatureUnit,FloatTemperature>
,FloatScalarInterface<TemperatureUnit,FloatTemperature>
,FloatScalarInterface.Rel<TemperatureUnit,FloatTemperature>
,FloatScalarInterface.RelWithAbs<AbsoluteTemperatureUnit,FloatAbsoluteTemperature,TemperatureUnit,FloatTemperature>
@Generated(value="org.djunits.generator.GenerateDJUNIT", date="2023-04-30T13:59:27.633664900Z") public class FloatTemperature extends AbstractFloatScalarRelWithAbs<AbsoluteTemperatureUnit,FloatAbsoluteTemperature,TemperatureUnit,FloatTemperature>
Easy access methods for the FloatTemperature FloatScalar.Copyright (c) 2013-2023 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
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.djunits.value.vfloat.scalar.base.FloatScalarInterface
FloatScalarInterface.Abs<AU extends AbsoluteLinearUnit<AU,RU>,A extends FloatScalarInterface.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends FloatScalarInterface.RelWithAbs<AU,A,RU,R>>, FloatScalarInterface.Rel<U extends Unit<U>,R extends FloatScalarInterface.Rel<U,R>>, FloatScalarInterface.RelWithAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends FloatScalarInterface.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends FloatScalarInterface.RelWithAbs<AU,A,RU,R>>
-
Nested classes/interfaces inherited from interface org.djunits.value.base.Scalar
Scalar.Abs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends Scalar.RelWithAbs<AU,A,RU,R>>, Scalar.Rel<U extends Unit<U>,R extends Scalar.Rel<U,R>>, Scalar.RelWithAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends Scalar.RelWithAbs<AU,A,RU,R>>
-
-
Field Summary
Fields Modifier and Type Field Description static FloatTemperature
NaN
Constant with value NaN.static FloatTemperature
NEG_MAXVALUE
Constant with value -MAX_VALUE.static FloatTemperature
NEGATIVE_INFINITY
Constant with value NEGATIVE_INFINITY.static FloatTemperature
ONE
Constant with value one.static FloatTemperature
POS_MAXVALUE
Constant with value MAX_VALUE.static FloatTemperature
POSITIVE_INFINITY
Constant with value POSITIVE_INFINITY.static FloatTemperature
ZERO
Constant with value zero.-
Fields inherited from class org.djunits.value.vfloat.scalar.base.AbstractFloatScalar
si
-
-
Constructor Summary
Constructors Constructor Description FloatTemperature(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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description FloatDimensionless
divide(FloatTemperature v)
Calculate the division of FloatTemperature and FloatTemperature, which results in a FloatDimensionless scalar.FloatAbsoluteTemperature
instantiateAbs(float value, AbsoluteTemperatureUnit unit)
Construct a new Absolute Immutable FloatScalar of the right type.FloatTemperature
instantiateRel(float value, TemperatureUnit unit)
Construct a new Relative Immutable FloatScalar of the right type.static 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
of(float value, String unitString)
Returns a FloatTemperature based on a value and the textual representation of the unit, which can be localized.FloatSIScalar
reciprocal()
Create the reciprocal of this scalar with the correct dimensions.static FloatTemperature
valueOf(String text)
Returns a FloatTemperature representation of a textual representation of a value with a unit.-
Methods inherited from class org.djunits.value.vfloat.scalar.base.AbstractFloatScalarRelWithAbs
plus
-
Methods inherited from class org.djunits.value.vfloat.scalar.base.AbstractFloatScalarRel
abs, ceil, divide, divide, divide, floor, minus, neg, plus, rint, times, times, times
-
Methods inherited from class org.djunits.value.vfloat.scalar.base.AbstractFloatScalar
compareTo, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, intValue, le, le0, longValue, lt, lt0, ne, ne0, toDisplayString, toDisplayString, toString, toString, toString, toString, toStringSIPrefixed, toStringSIPrefixed, toTextualString, toTextualString
-
Methods inherited from class org.djunits.value.AbstractScalar
getDisplayUnit, isAbsolute, isRelative, 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 java.lang.Comparable
compareTo
-
Methods inherited from interface org.djunits.value.vfloat.scalar.base.FloatScalarInterface
getInUnit, getInUnit, getSI
-
Methods inherited from interface org.djunits.value.base.Scalar
eq, eq0, format, format, ge, ge0, gt, gt0, le, le0, lt, lt0, ne, ne0, toDisplayString, toDisplayString, toTextualString, toTextualString
-
Methods inherited from interface org.djunits.value.base.Scalar.Rel
minus, plus
-
Methods inherited from interface org.djunits.value.Value
getDisplayUnit, isAbsolute, isRelative, setDisplayUnit, toString, toString, toString, toString
-
-
-
-
Field Detail
-
ZERO
public static final FloatTemperature ZERO
Constant with value zero.
-
ONE
public static final FloatTemperature ONE
Constant with value one.
-
NaN
public static final FloatTemperature NaN
Constant with value NaN.
-
POSITIVE_INFINITY
public static final FloatTemperature POSITIVE_INFINITY
Constant with value POSITIVE_INFINITY.
-
NEGATIVE_INFINITY
public static final FloatTemperature NEGATIVE_INFINITY
Constant with value NEGATIVE_INFINITY.
-
POS_MAXVALUE
public static final FloatTemperature POS_MAXVALUE
Constant with value MAX_VALUE.
-
NEG_MAXVALUE
public static final FloatTemperature NEG_MAXVALUE
Constant with value -MAX_VALUE.
-
-
Constructor Detail
-
FloatTemperature
public FloatTemperature(float value, TemperatureUnit unit)
Construct FloatTemperature scalar.- Parameters:
value
- float; the float valueunit
- TemperatureUnit; unit for the float value
-
FloatTemperature
public FloatTemperature(FloatTemperature value)
Construct FloatTemperature scalar.- Parameters:
value
- FloatTemperature; Scalar from which to construct this instance
-
FloatTemperature
public FloatTemperature(double value, TemperatureUnit unit)
Construct FloatTemperature scalar using a double value.- Parameters:
value
- double; the double valueunit
- TemperatureUnit; unit for the resulting float value
-
-
Method Detail
-
instantiateRel
public final FloatTemperature instantiateRel(float value, TemperatureUnit unit)
Construct a new Relative Immutable FloatScalar of the right type. Each extending class must implement this method.- Parameters:
value
- float; the float valueunit
- RU; the unit- Returns:
- R a new relative instance of the FloatScalar of the right type
-
instantiateSI
public static final FloatTemperature instantiateSI(float value)
Construct FloatTemperature scalar.- Parameters:
value
- float; the float value in SI units- Returns:
- FloatTemperature; the new scalar with the SI value
-
instantiateAbs
public final FloatAbsoluteTemperature instantiateAbs(float value, AbsoluteTemperatureUnit unit)
Construct a new Absolute Immutable FloatScalar of the right type. Each extending class must implement this method.- 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
public static FloatTemperature max(FloatTemperature r1, FloatTemperature r2)
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
public static FloatTemperature min(FloatTemperature r1, FloatTemperature r2)
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
public static FloatTemperature valueOf(String text)
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
public static FloatTemperature of(float value, String unitString)
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
public final FloatDimensionless divide(FloatTemperature v)
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
public FloatSIScalar reciprocal()
Create the reciprocal of this scalar with the correct dimensions.- Specified by:
reciprocal
in classAbstractFloatScalarRel<TemperatureUnit,FloatTemperature>
- Returns:
- FloatScalar<?>; a new scalar instance with correct SI dimensions
-
-