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