Package org.djunits.value.vfloat.scalar
Class FloatForce
- 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<ForceUnit,FloatForce>
-
- org.djunits.value.vfloat.scalar.FloatForce
-
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable<FloatForce>
,Scalar<ForceUnit,FloatForce>
,Scalar.Rel<ForceUnit,FloatForce>
,ValueFunctions<ForceUnit,FloatForce>
,Relative<ForceUnit,FloatForce>
,Value<ForceUnit,FloatForce>
,FloatScalarInterface<ForceUnit,FloatForce>
,FloatScalarInterface.Rel<ForceUnit,FloatForce>
@Generated(value="org.djunits.generator.GenerateDJUNIT", date="2023-04-30T13:59:27.633664900Z") public class FloatForce extends AbstractFloatScalarRel<ForceUnit,FloatForce>
Easy access methods for the FloatForce FloatScalar, which is relative by definition.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 FloatForce
NaN
Constant with value NaN.static FloatForce
NEG_MAXVALUE
Constant with value -MAX_VALUE.static FloatForce
NEGATIVE_INFINITY
Constant with value NEGATIVE_INFINITY.static FloatForce
ONE
Constant with value one.static FloatForce
POS_MAXVALUE
Constant with value MAX_VALUE.static FloatForce
POSITIVE_INFINITY
Constant with value POSITIVE_INFINITY.static FloatForce
ZERO
Constant with value zero.-
Fields inherited from class org.djunits.value.vfloat.scalar.base.AbstractFloatScalar
si
-
-
Constructor Summary
Constructors Constructor Description FloatForce(double value, ForceUnit unit)
Construct FloatForce scalar using a double value.FloatForce(float value, ForceUnit unit)
Construct FloatForce scalar.FloatForce(FloatForce value)
Construct FloatForce scalar.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description FloatMass
divide(FloatAcceleration v)
Calculate the division of FloatForce and FloatAcceleration, which results in a FloatMass scalar.FloatPressure
divide(FloatArea v)
Calculate the division of FloatForce and FloatArea, which results in a FloatPressure scalar.FloatLinearDensity
divide(FloatEnergy v)
Calculate the division of FloatForce and FloatEnergy, which results in a FloatLinearDensity scalar.FloatDimensionless
divide(FloatForce v)
Calculate the division of FloatForce and FloatForce, which results in a FloatDimensionless scalar.FloatEnergy
divide(FloatLinearDensity v)
Calculate the division of FloatForce and FloatLinearDensity, which results in a FloatEnergy scalar.FloatAcceleration
divide(FloatMass v)
Calculate the division of FloatForce and FloatMass, which results in a FloatAcceleration scalar.FloatArea
divide(FloatPressure v)
Calculate the division of FloatForce and FloatPressure, which results in a FloatArea scalar.FloatForce
instantiateRel(float value, ForceUnit unit)
Construct a new Relative Immutable FloatScalar of the right type.static FloatForce
instantiateSI(float value)
Construct FloatForce scalar.static FloatForce
interpolate(FloatForce zero, FloatForce one, float ratio)
Interpolate between two values.static FloatForce
max(FloatForce r1, FloatForce r2)
Return the maximum value of two relative scalars.static FloatForce
max(FloatForce r1, FloatForce r2, FloatForce... rn)
Return the maximum value of more than two relative scalars.static FloatForce
min(FloatForce r1, FloatForce r2)
Return the minimum value of two relative scalars.static FloatForce
min(FloatForce r1, FloatForce r2, FloatForce... rn)
Return the minimum value of more than two relative scalars.static FloatForce
of(float value, String unitString)
Returns a FloatForce 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.FloatEnergy
times(FloatLength v)
Calculate the multiplication of FloatForce and FloatLength, which results in a FloatEnergy scalar.FloatPower
times(FloatSpeed v)
Calculate the multiplication of FloatForce and FloatSpeed, which results in a FloatPower scalar.static FloatForce
valueOf(String text)
Returns a FloatForce representation of a textual representation of a value with a unit.-
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.Value
getDisplayUnit, isAbsolute, isRelative, setDisplayUnit, toString, toString, toString, toString
-
-
-
-
Field Detail
-
ZERO
public static final FloatForce ZERO
Constant with value zero.
-
ONE
public static final FloatForce ONE
Constant with value one.
-
NaN
public static final FloatForce NaN
Constant with value NaN.
-
POSITIVE_INFINITY
public static final FloatForce POSITIVE_INFINITY
Constant with value POSITIVE_INFINITY.
-
NEGATIVE_INFINITY
public static final FloatForce NEGATIVE_INFINITY
Constant with value NEGATIVE_INFINITY.
-
POS_MAXVALUE
public static final FloatForce POS_MAXVALUE
Constant with value MAX_VALUE.
-
NEG_MAXVALUE
public static final FloatForce NEG_MAXVALUE
Constant with value -MAX_VALUE.
-
-
Constructor Detail
-
FloatForce
public FloatForce(float value, ForceUnit unit)
Construct FloatForce scalar.- Parameters:
value
- float; the float valueunit
- unit for the float value
-
FloatForce
public FloatForce(FloatForce value)
Construct FloatForce scalar.- Parameters:
value
- Scalar from which to construct this instance
-
FloatForce
public FloatForce(double value, ForceUnit unit)
Construct FloatForce scalar using a double value.- Parameters:
value
- double; the double valueunit
- unit for the resulting float value
-
-
Method Detail
-
instantiateRel
public final FloatForce instantiateRel(float value, ForceUnit unit)
Construct a new Relative Immutable FloatScalar of the right type. Each extending class must implement this method.- Parameters:
value
- float; the float valueunit
- U; the unit- Returns:
- R a new relative instance of the FloatScalar of the right type
-
instantiateSI
public static final FloatForce instantiateSI(float value)
Construct FloatForce scalar.- Parameters:
value
- float; the float value in SI units- Returns:
- the new scalar with the SI value
-
interpolate
public static FloatForce interpolate(FloatForce zero, FloatForce 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 FloatForce max(FloatForce r1, FloatForce 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 FloatForce max(FloatForce r1, FloatForce r2, FloatForce... 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 FloatForce min(FloatForce r1, FloatForce 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 FloatForce min(FloatForce r1, FloatForce r2, FloatForce... 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
public static FloatForce valueOf(String text)
Returns a FloatForce 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 FloatForce- Returns:
- FloatForce; 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 FloatForce of(float value, String unitString)
Returns a FloatForce 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:
- FloatForce; 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(FloatForce v)
Calculate the division of FloatForce and FloatForce, which results in a FloatDimensionless scalar.- Parameters:
v
- FloatForce; scalar- Returns:
- FloatDimensionless; scalar as a division of FloatForce and FloatForce
-
times
public final FloatEnergy times(FloatLength v)
Calculate the multiplication of FloatForce and FloatLength, which results in a FloatEnergy scalar.- Parameters:
v
- FloatForce; scalar- Returns:
- FloatEnergy; scalar as a multiplication of FloatForce and FloatLength
-
divide
public final FloatEnergy divide(FloatLinearDensity v)
Calculate the division of FloatForce and FloatLinearDensity, which results in a FloatEnergy scalar.- Parameters:
v
- FloatForce; scalar- Returns:
- FloatEnergy; scalar as a division of FloatForce and FloatLinearDensity
-
divide
public final FloatLinearDensity divide(FloatEnergy v)
Calculate the division of FloatForce and FloatEnergy, which results in a FloatLinearDensity scalar.- Parameters:
v
- FloatForce; scalar- Returns:
- FloatLinearDensity; scalar as a division of FloatForce and FloatEnergy
-
times
public final FloatPower times(FloatSpeed v)
Calculate the multiplication of FloatForce and FloatSpeed, which results in a FloatPower scalar.- Parameters:
v
- FloatForce; scalar- Returns:
- FloatPower; scalar as a multiplication of FloatForce and FloatSpeed
-
divide
public final FloatAcceleration divide(FloatMass v)
Calculate the division of FloatForce and FloatMass, which results in a FloatAcceleration scalar.- Parameters:
v
- FloatForce; scalar- Returns:
- FloatAcceleration; scalar as a division of FloatForce and FloatMass
-
divide
public final FloatMass divide(FloatAcceleration v)
Calculate the division of FloatForce and FloatAcceleration, which results in a FloatMass scalar.- Parameters:
v
- FloatForce; scalar- Returns:
- FloatMass; scalar as a division of FloatForce and FloatAcceleration
-
divide
public final FloatPressure divide(FloatArea v)
Calculate the division of FloatForce and FloatArea, which results in a FloatPressure scalar.- Parameters:
v
- FloatForce; scalar- Returns:
- FloatPressure; scalar as a division of FloatForce and FloatArea
-
divide
public final FloatArea divide(FloatPressure v)
Calculate the division of FloatForce and FloatPressure, which results in a FloatArea scalar.- Parameters:
v
- FloatForce; scalar- Returns:
- FloatArea; scalar as a division of FloatForce and FloatPressure
-
reciprocal
public FloatSIScalar reciprocal()
Create the reciprocal of this scalar with the correct dimensions.- Specified by:
reciprocal
in classAbstractFloatScalarRel<ForceUnit,FloatForce>
- Returns:
- FloatScalar<?>; a new scalar instance with correct SI dimensions
-
-