Package org.djunits.value.vfloat.scalar

Class FloatSpeed

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<SpeedUnit,FloatSpeed>

org.djunits.value.vfloat.scalar.FloatSpeed

All Implemented Interfaces:

Serializable, Cloneable, Comparable<FloatSpeed>, Relative<SpeedUnit,FloatSpeed>, Value<SpeedUnit,FloatSpeed>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-07-23T14:06:38.224104100Z")
public class FloatSpeed
extends FloatScalarRel<SpeedUnit,FloatSpeed>

Easy access methods for the FloatSpeed 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:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final FloatSpeed	NaN	Constant with value NaN.
static final FloatSpeed	NEG_MAXVALUE	Constant with value -MAX_VALUE.
static final FloatSpeed	NEGATIVE_INFINITY	Constant with value NEGATIVE_INFINITY.
static final FloatSpeed	ONE	Constant with value one.
static final FloatSpeed	POS_MAXVALUE	Constant with value MAX_VALUE.
static final FloatSpeed	POSITIVE_INFINITY	Constant with value POSITIVE_INFINITY.
static final FloatSpeed	ZERO	Constant with value zero.

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

si

Constructor Summary

Constructors

Constructor	Description
FloatSpeed(double value, SpeedUnit unit)	Construct FloatSpeed scalar using a double value.
FloatSpeed(float value, SpeedUnit unit)	Construct FloatSpeed scalar.
FloatSpeed(FloatSpeed value)	Construct FloatSpeed scalar.

Method Summary

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

public static final FloatSpeed ZERO

Constant with value zero.

ONE

public static final FloatSpeed ONE

Constant with value one.

NaN

public static final FloatSpeed NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final FloatSpeed POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatSpeed NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatSpeed POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatSpeed NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

FloatSpeed

public FloatSpeed(float value,
 SpeedUnit unit)

Construct FloatSpeed scalar.

Parameters:

value - float; the float value

unit - unit for the float value

FloatSpeed

public FloatSpeed(FloatSpeed value)

Construct FloatSpeed scalar.

Parameters:

value - Scalar from which to construct this instance

FloatSpeed

public FloatSpeed(double value,
 SpeedUnit unit)

Construct FloatSpeed scalar using a double value.

Parameters:

value - double; the double value

unit - unit for the resulting float value

Method Details

instantiateRel

public final FloatSpeed instantiateRel(float value,
 SpeedUnit unit)

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

Specified by:

instantiateRel in class FloatScalarRel<SpeedUnit,FloatSpeed>

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 FloatSpeed instantiateSI(float value)

Construct FloatSpeed scalar.

Parameters:

value - float; the float value in SI units

Returns:

the new scalar with the SI value

interpolate

public static FloatSpeed interpolate(FloatSpeed zero,
 FloatSpeed 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 FloatSpeed max(FloatSpeed r1,
 FloatSpeed 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 FloatSpeed max(FloatSpeed r1,
 FloatSpeed r2,
 FloatSpeed... 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 FloatSpeed min(FloatSpeed r1,
 FloatSpeed 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 FloatSpeed min(FloatSpeed r1,
 FloatSpeed r2,
 FloatSpeed... 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 FloatSpeed valueOf(String text)

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

Returns:

FloatSpeed; 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 FloatSpeed of(float value,
 String unitString)

Returns a FloatSpeed 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:

FloatSpeed; 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(FloatSpeed v)

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

Parameters:

v - FloatSpeed; scalar

Returns:

FloatDimensionless; scalar as a division of FloatSpeed and FloatSpeed

times

public final FloatFlowVolume times(FloatArea v)

Calculate the multiplication of FloatSpeed and FloatArea, which results in a FloatFlowVolume scalar.

Parameters:

v - FloatSpeed; scalar

Returns:

FloatFlowVolume; scalar as a multiplication of FloatSpeed and FloatArea

times

public final FloatPower times(FloatForce v)

Calculate the multiplication of FloatSpeed and FloatForce, which results in a FloatPower scalar.

Parameters:

v - FloatSpeed; scalar

Returns:

FloatPower; scalar as a multiplication of FloatSpeed and FloatForce

times

public final FloatAcceleration times(FloatFrequency v)

Calculate the multiplication of FloatSpeed and FloatFrequency, which results in a FloatAcceleration scalar.

Parameters:

v - FloatSpeed; scalar

Returns:

FloatAcceleration; scalar as a multiplication of FloatSpeed and FloatFrequency

divide

public final FloatFrequency divide(FloatLength v)

Calculate the division of FloatSpeed and FloatLength, which results in a FloatFrequency scalar.

Parameters:

v - FloatSpeed; scalar

Returns:

FloatFrequency; scalar as a division of FloatSpeed and FloatLength

divide

public final FloatLength divide(FloatFrequency v)

Calculate the division of FloatSpeed and FloatFrequency, which results in a FloatLength scalar.

Parameters:

v - FloatSpeed; scalar

Returns:

FloatLength; scalar as a division of FloatSpeed and FloatFrequency

times

public final FloatFrequency times(FloatLinearDensity v)

Calculate the multiplication of FloatSpeed and FloatLinearDensity, which results in a FloatFrequency scalar.

Parameters:

v - FloatSpeed; scalar

Returns:

FloatFrequency; scalar as a multiplication of FloatSpeed and FloatLinearDensity

times

public final FloatLength times(FloatDuration v)

Calculate the multiplication of FloatSpeed and FloatDuration, which results in a FloatLength scalar.

Parameters:

v - FloatSpeed; scalar

Returns:

FloatLength; scalar as a multiplication of FloatSpeed and FloatDuration

divide

public final FloatAcceleration divide(FloatDuration v)

Calculate the division of FloatSpeed and FloatDuration, which results in a FloatAcceleration scalar.

Parameters:

v - FloatSpeed; scalar

Returns:

FloatAcceleration; scalar as a division of FloatSpeed and FloatDuration

divide

public final FloatDuration divide(FloatAcceleration v)

Calculate the division of FloatSpeed and FloatAcceleration, which results in a FloatDuration scalar.

Parameters:

v - FloatSpeed; scalar

Returns:

FloatDuration; scalar as a division of FloatSpeed and FloatAcceleration

times

public final FloatForce times(FloatFlowMass v)

Calculate the multiplication of FloatSpeed and FloatFlowMass, which results in a FloatForce scalar.

Parameters:

v - FloatSpeed; scalar

Returns:

FloatForce; scalar as a multiplication of FloatSpeed and FloatFlowMass

times

public final FloatMomentum times(FloatMass v)

Calculate the multiplication of FloatSpeed and FloatMass, which results in a FloatMomentum scalar.

Parameters:

v - FloatSpeed; scalar

Returns:

FloatMomentum; scalar as a multiplication of FloatSpeed and FloatMass

times

public final FloatEnergy times(FloatMomentum v)

Calculate the multiplication of FloatSpeed and FloatMomentum, which results in a FloatEnergy scalar.

Parameters:

v - FloatSpeed; scalar

Returns:

FloatEnergy; scalar as a multiplication of FloatSpeed and FloatMomentum

reciprocal

public FloatSIScalar reciprocal()

Create the reciprocal of this scalar with the correct dimensions.

Specified by:

reciprocal in class FloatScalarRel<SpeedUnit,FloatSpeed>

Returns:

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