Package org.djunits.value.vfloat.scalar

Class FloatTorque

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<TorqueUnit,FloatTorque>

org.djunits.value.vfloat.scalar.FloatTorque

All Implemented Interfaces:

Serializable, Cloneable, Comparable<FloatTorque>, Scalar<TorqueUnit,FloatTorque>, Scalar.Rel<TorqueUnit,FloatTorque>, ValueFunctions<TorqueUnit,FloatTorque>, Relative<TorqueUnit,FloatTorque>, Value<TorqueUnit,FloatTorque>, FloatScalarInterface<TorqueUnit,FloatTorque>, FloatScalarInterface.Rel<TorqueUnit,FloatTorque>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-04-30T13:59:27.633664900Z")
public class FloatTorque
extends AbstractFloatScalarRel<TorqueUnit,FloatTorque>

Easy access methods for the FloatTorque 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 FloatTorque	NaN	Constant with value NaN.
static FloatTorque	NEG_MAXVALUE	Constant with value -MAX_VALUE.
static FloatTorque	NEGATIVE_INFINITY	Constant with value NEGATIVE_INFINITY.
static FloatTorque	ONE	Constant with value one.
static FloatTorque	POS_MAXVALUE	Constant with value MAX_VALUE.
static FloatTorque	POSITIVE_INFINITY	Constant with value POSITIVE_INFINITY.
static FloatTorque	ZERO	Constant with value zero.

Fields inherited from class org.djunits.value.vfloat.scalar.base.AbstractFloatScalar

si

Constructor Summary

Constructors

Constructor	Description
FloatTorque(double value, TorqueUnit unit)	Construct FloatTorque scalar using a double value.
FloatTorque(float value, TorqueUnit unit)	Construct FloatTorque scalar.
FloatTorque(FloatTorque value)	Construct FloatTorque scalar.

Method Summary

Modifier and Type	Method	Description
FloatPower	divide(FloatDuration v)	Calculate the division of FloatTorque and FloatDuration, which results in a FloatPower scalar.
FloatLength	divide(FloatForce v)	Calculate the division of FloatTorque and FloatForce, which results in a FloatLength scalar.
FloatForce	divide(FloatLength v)	Calculate the division of FloatTorque and FloatLength, which results in a FloatForce scalar.
FloatDuration	divide(FloatPower v)	Calculate the division of FloatTorque and FloatPower, which results in a FloatDuration scalar.
FloatVolume	divide(FloatPressure v)	Calculate the division of FloatTorque and FloatPressure, which results in a FloatVolume scalar.
FloatDimensionless	divide(FloatTorque v)	Calculate the division of FloatTorque and FloatTorque, which results in a FloatDimensionless scalar.
FloatPressure	divide(FloatVolume v)	Calculate the division of FloatTorque and FloatVolume, which results in a FloatPressure scalar.
FloatTorque	instantiateRel(float value, TorqueUnit unit)	Construct a new Relative Immutable FloatScalar of the right type.
static FloatTorque	instantiateSI(float value)	Construct FloatTorque scalar.
static FloatTorque	interpolate(FloatTorque zero, FloatTorque one, float ratio)	Interpolate between two values.
static FloatTorque	max(FloatTorque r1, FloatTorque r2)	Return the maximum value of two relative scalars.
static FloatTorque	max(FloatTorque r1, FloatTorque r2, FloatTorque... rn)	Return the maximum value of more than two relative scalars.
static FloatTorque	min(FloatTorque r1, FloatTorque r2)	Return the minimum value of two relative scalars.
static FloatTorque	min(FloatTorque r1, FloatTorque r2, FloatTorque... rn)	Return the minimum value of more than two relative scalars.
static FloatTorque	of(float value, String unitString)	Returns a FloatTorque 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.
FloatPower	times(FloatFrequency v)	Calculate the multiplication of FloatTorque and FloatFrequency, which results in a FloatPower scalar.
FloatForce	times(FloatLinearDensity v)	Calculate the multiplication of FloatTorque and FloatLinearDensity, which results in a FloatForce scalar.
static FloatTorque	valueOf(String text)	Returns a FloatTorque 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 FloatTorque ZERO

Constant with value zero.

ONE

public static final FloatTorque ONE

Constant with value one.

NaN

public static final FloatTorque NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final FloatTorque POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatTorque NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatTorque POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatTorque NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Detail

FloatTorque

public FloatTorque(float value,
                   TorqueUnit unit)

Construct FloatTorque scalar.

Parameters:

value - float; the float value

unit - unit for the float value

FloatTorque

public FloatTorque(FloatTorque value)

Construct FloatTorque scalar.

Parameters:

value - Scalar from which to construct this instance

FloatTorque

public FloatTorque(double value,
                   TorqueUnit unit)

Construct FloatTorque scalar using a double value.

Parameters:

value - double; the double value

unit - unit for the resulting float value

Method Detail

instantiateRel

public final FloatTorque instantiateRel(float value,
                                        TorqueUnit unit)

Construct a new Relative Immutable FloatScalar of the right type. Each extending class must implement this method.

Parameters:

value - float; the float value

unit - U; the unit

Returns:

R a new relative instance of the FloatScalar of the right type

instantiateSI

public static final FloatTorque instantiateSI(float value)

Construct FloatTorque scalar.

Parameters:

value - float; the float value in SI units

Returns:

the new scalar with the SI value

interpolate

public static FloatTorque interpolate(FloatTorque zero,
                                      FloatTorque one,
                                      float ratio)

Interpolate between two values.

Parameters:

zero - the low value

one - the high value

ratio - double; the ratio between 0 and 1, inclusive

Returns:

a Scalar at the ratio between

max

public static FloatTorque max(FloatTorque r1,
                              FloatTorque r2)

Return the maximum value of two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

Returns:

the maximum value of two relative scalars

max

public static FloatTorque max(FloatTorque r1,
                              FloatTorque r2,
                              FloatTorque... rn)

Return the maximum value of more than two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

rn - the other scalars

Returns:

the maximum value of more than two relative scalars

min

public static FloatTorque min(FloatTorque r1,
                              FloatTorque r2)

Return the minimum value of two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

Returns:

the minimum value of two relative scalars

min

public static FloatTorque min(FloatTorque r1,
                              FloatTorque r2,
                              FloatTorque... rn)

Return the minimum value of more than two relative scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

rn - the other scalars

Returns:

the minimum value of more than two relative scalars

valueOf

public static FloatTorque valueOf(String text)

Returns a FloatTorque 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 FloatTorque

Returns:

FloatTorque; the Scalar representation of the value in its unit

Throws:

IllegalArgumentException - when the text cannot be parsed

NullPointerException - when the text argument is null

of

public static FloatTorque of(float value,
                             String unitString)

Returns a FloatTorque based on a value and the textual representation of the unit, which can be localized.

Parameters:

value - double; the value to use

unitString - String; the textual representation of the unit

Returns:

FloatTorque; the Scalar representation of the value in its unit

Throws:

IllegalArgumentException - when the unit cannot be parsed or is incorrect

NullPointerException - when the unitString argument is null

divide

public final FloatDimensionless divide(FloatTorque v)

Calculate the division of FloatTorque and FloatTorque, which results in a FloatDimensionless scalar.

Parameters:

v - FloatTorque; scalar

Returns:

FloatDimensionless; scalar as a division of FloatTorque and FloatTorque

divide

public final FloatLength divide(FloatForce v)

Calculate the division of FloatTorque and FloatForce, which results in a FloatLength scalar.

Parameters:

v - FloatTorque; scalar

Returns:

FloatLength; scalar as a division of FloatTorque and FloatForce

divide

public final FloatForce divide(FloatLength v)

Calculate the division of FloatTorque and FloatLength, which results in a FloatForce scalar.

Parameters:

v - FloatTorque; scalar

Returns:

FloatForce; scalar as a division of FloatTorque and FloatLength

times

public final FloatForce times(FloatLinearDensity v)

Calculate the multiplication of FloatTorque and FloatLinearDensity, which results in a FloatForce scalar.

Parameters:

v - FloatTorque; scalar

Returns:

FloatForce; scalar as a multiplication of FloatTorque and FloatLinearDensity

divide

public final FloatPower divide(FloatDuration v)

Calculate the division of FloatTorque and FloatDuration, which results in a FloatPower scalar.

Parameters:

v - FloatTorque; scalar

Returns:

FloatPower; scalar as a division of FloatTorque and FloatDuration

divide

public final FloatDuration divide(FloatPower v)

Calculate the division of FloatTorque and FloatPower, which results in a FloatDuration scalar.

Parameters:

v - FloatTorque; scalar

Returns:

FloatDuration; scalar as a division of FloatTorque and FloatPower

times

public final FloatPower times(FloatFrequency v)

Calculate the multiplication of FloatTorque and FloatFrequency, which results in a FloatPower scalar.

Parameters:

v - FloatTorque; scalar

Returns:

FloatPower; scalar as a multiplication of FloatTorque and FloatFrequency

divide

public final FloatPressure divide(FloatVolume v)

Calculate the division of FloatTorque and FloatVolume, which results in a FloatPressure scalar.

Parameters:

v - FloatTorque; scalar

Returns:

FloatPressure; scalar as a division of FloatTorque and FloatVolume

divide

public final FloatVolume divide(FloatPressure v)

Calculate the division of FloatTorque and FloatPressure, which results in a FloatVolume scalar.

Parameters:

v - FloatTorque; scalar

Returns:

FloatVolume; scalar as a division of FloatTorque and FloatPressure

reciprocal

public FloatSIScalar reciprocal()

Create the reciprocal of this scalar with the correct dimensions.

Specified by:

reciprocal in class AbstractFloatScalarRel<TorqueUnit,FloatTorque>

Returns:

FloatScalar<?>; a new scalar instance with correct SI dimensions