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