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