org.djunits.value.vfloat.scalar

Class FloatSpeed

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vfloat.scalar.AbstractFloatScalar<U,R>

org.djunits.value.vfloat.scalar.AbstractFloatScalarRel<SpeedUnit,FloatSpeed>

org.djunits.value.vfloat.scalar.FloatSpeed

All Implemented Interfaces:

Serializable, Comparable<FloatSpeed>, MathFunctionsAbs<FloatSpeed>, MathFunctionsRel<FloatSpeed>, Relative, Value<SpeedUnit>, FloatMathFunctions<FloatSpeed>, FloatScalarInterface

public class FloatSpeed
extends AbstractFloatScalarRel<SpeedUnit,FloatSpeed>

Easy access methods for the Speed FloatScalar, which is relative by definition. An example is Speed. Instead of:

 FloatScalar.Rel<SpeedUnit> value = new FloatScalar.Rel<SpeedUnit>(100.0, SpeedUnit.SI);
 

we can now write:

 FloatSpeed value = new FloatSpeed(100.0, SpeedUnit.SI);
 

The compiler will automatically recognize which units belong to which quantity, and whether the quantity type and the unit used are compatible.

Copyright (c) 2013-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

$LastChangedDate: 2019-03-03 00:53:50 +0100 (Sun, 03 Mar 2019) $, @version $Revision: 349 $, by $Author: averbraeck $, initial version Sep 5, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static FloatSpeed	NaN constant with value NaN.
static FloatSpeed	NEG_MAXVALUE constant with value -MAX_VALUE.
static FloatSpeed	NEGATIVE_INFINITY constant with value NEGATIVE_INFINITY.
static FloatSpeed	POS_MAXVALUE constant with value MAX_VALUE.
static FloatSpeed	POSITIVE_INFINITY constant with value POSITIVE_INFINITY.
static FloatSpeed	ZERO constant with value zero.

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

si

Fields inherited from class org.djunits.value.Scalar

NUMBER_PATTERN

Fields inherited from interface org.djunits.value.vfloat.FloatMathFunctions

ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, NEG, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH, TO_DEGREES, TO_RADIANS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static FloatSpeed	createSI(float value) Construct FloatSpeed scalar.
FloatDuration	divideBy(FloatAcceleration v) Calculate the division of FloatSpeed and FloatAcceleration, which results in a FloatDuration scalar.
FloatAcceleration	divideBy(FloatDuration v) Calculate the division of FloatSpeed and FloatDuration, which results in a FloatAcceleration scalar.
FloatLength	divideBy(FloatFrequency v) Calculate the division of FloatSpeed and FloatFrequency, which results in a FloatLength scalar.
FloatFrequency	divideBy(FloatLength v) Calculate the division of FloatSpeed and FloatLength, which results in a FloatFrequency scalar.
FloatDimensionless	divideBy(FloatSpeed v) Calculate the division of FloatSpeed and FloatSpeed, which results in a FloatDimensionless scalar.
FloatSpeed	instantiateRel(float value, SpeedUnit unit) Construct a new Relative Immutable FloatScalar of the right type.
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.
FloatFlowVolume	multiplyBy(FloatArea v) Calculate the multiplication of FloatSpeed and FloatArea, which results in a FloatFlowVolume scalar.
FloatLength	multiplyBy(FloatDuration v) Calculate the multiplication of FloatSpeed and FloatDuration, which results in a FloatLength scalar.
FloatForce	multiplyBy(FloatFlowMass v) Calculate the multiplication of FloatSpeed and FloatFlowMass, which results in a FloatForce scalar.
FloatPower	multiplyBy(FloatForce v) Calculate the multiplication of FloatSpeed and FloatForce, which results in a FloatPower scalar.
FloatAcceleration	multiplyBy(FloatFrequency v) Calculate the multiplication of FloatSpeed and FloatFrequency, which results in a FloatAcceleration scalar.
FloatFrequency	multiplyBy(FloatLinearDensity v) Calculate the multiplication of FloatSpeed and FloatLinearDensity, which results in a FloatFrequency 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.AbstractFloatScalarRel

abs, ceil, divideBy, floor, minus, multiplyBy, neg, plus, rint, round

Methods inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalar

compareTo, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, intValue, le, le0, longValue, lt, lt0, ne, ne0, toString, toString, toString, toString

Methods inherited from class org.djunits.value.Scalar

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative, setDisplayUnit, stringOf, stringOfDefaultLocale, textualStringOf, textualStringOfDefaultLocale

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.vfloat.FloatMathFunctions

DIV, MULT, POW

Field Detail

ZERO

public static final FloatSpeed ZERO

constant with value zero.

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 Detail

FloatSpeed

public FloatSpeed(float value,
                  SpeedUnit unit)

Construct FloatSpeed scalar.

Parameters:

value - 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 value

unit - unit for the resulting float value

Method Detail

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 AbstractFloatScalarRel<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

createSI

public static final FloatSpeed createSI(float value)

Construct FloatSpeed scalar.

Parameters:

value - 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 - 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)
                          throws IllegalArgumentException

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 the official abbreviation of the unit. Spaces are allowed, but not necessary, between the value and the unit.

Parameters:

text - String; the textual representation to parse into a FloatSpeed

Returns:

the String representation of the value in its unit, followed by the official abbreviation of the unit

Throws:

IllegalArgumentException - when the text cannot be parsed

divideBy

public final FloatDimensionless divideBy(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

multiplyBy

public final FloatFlowVolume multiplyBy(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

multiplyBy

public final FloatPower multiplyBy(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

multiplyBy

public final FloatAcceleration multiplyBy(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

divideBy

public final FloatFrequency divideBy(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

divideBy

public final FloatLength divideBy(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

multiplyBy

public final FloatFrequency multiplyBy(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

multiplyBy

public final FloatLength multiplyBy(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

divideBy

public final FloatAcceleration divideBy(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

divideBy

public final FloatDuration divideBy(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

multiplyBy

public final FloatForce multiplyBy(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