org.djunits.value.vdouble.scalar

Class Speed

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vdouble.scalar.AbstractDoubleScalar<U,R>

org.djunits.value.vdouble.scalar.AbstractDoubleScalarRel<SpeedUnit,Speed>

org.djunits.value.vdouble.scalar.Speed

All Implemented Interfaces:

Serializable, Comparable<Speed>, MathFunctionsAbs<Speed>, MathFunctionsRel<Speed>, Relative, Value<SpeedUnit>, DoubleMathFunctions<Speed>, DoubleScalarInterface

public class Speed
extends AbstractDoubleScalarRel<SpeedUnit,Speed>

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

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

we can now write:

 Speed value = new Speed(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 Speed	NaN constant with value NaN.
static Speed	NEG_MAXVALUE constant with value -MAX_VALUE.
static Speed	NEGATIVE_INFINITY constant with value NEGATIVE_INFINITY.
static Speed	POS_MAXVALUE constant with value MAX_VALUE.
static Speed	POSITIVE_INFINITY constant with value POSITIVE_INFINITY.
static Speed	ZERO constant with value zero.

Fields inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalar

si

Fields inherited from class org.djunits.value.Scalar

NUMBER_PATTERN

Fields inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

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

Constructor Summary

Constructors

Constructor and Description
Speed(double value, SpeedUnit unit) Construct Speed scalar.
Speed(Speed value) Construct Speed scalar.

Method Summary

Modifier and Type	Method and Description
static Speed	createSI(double value) Construct Speed scalar.
Duration	divideBy(Acceleration v) Calculate the division of Speed and Acceleration, which results in a Duration scalar.
Acceleration	divideBy(Duration v) Calculate the division of Speed and Duration, which results in a Acceleration scalar.
Length	divideBy(Frequency v) Calculate the division of Speed and Frequency, which results in a Length scalar.
Frequency	divideBy(Length v) Calculate the division of Speed and Length, which results in a Frequency scalar.
Dimensionless	divideBy(Speed v) Calculate the division of Speed and Speed, which results in a Dimensionless scalar.
Speed	instantiateRel(double value, SpeedUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
static Speed	interpolate(Speed zero, Speed one, double ratio) Interpolate between two values.
static Speed	max(Speed r1, Speed r2) Return the maximum value of two relative scalars.
static Speed	max(Speed r1, Speed r2, Speed... rn) Return the maximum value of more than two relative scalars.
static Speed	min(Speed r1, Speed r2) Return the minimum value of two relative scalars.
static Speed	min(Speed r1, Speed r2, Speed... rn) Return the minimum value of more than two relative scalars.
FlowVolume	multiplyBy(Area v) Calculate the multiplication of Speed and Area, which results in a FlowVolume scalar.
Length	multiplyBy(Duration v) Calculate the multiplication of Speed and Duration, which results in a Length scalar.
Force	multiplyBy(FlowMass v) Calculate the multiplication of Speed and FlowMass, which results in a Force scalar.
Power	multiplyBy(Force v) Calculate the multiplication of Speed and Force, which results in a Power scalar.
Acceleration	multiplyBy(Frequency v) Calculate the multiplication of Speed and Frequency, which results in a Acceleration scalar.
Frequency	multiplyBy(LinearDensity v) Calculate the multiplication of Speed and LinearDensity, which results in a Frequency scalar.
static Speed	valueOf(String text) Returns a Speed representation of a textual representation of a value with a unit.

Methods inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalarRel

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

Methods inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalar

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.vdouble.DoubleMathFunctions

DIV, MULT, POW

Field Detail

ZERO

public static final Speed ZERO

constant with value zero.

NaN

public static final Speed NaN

constant with value NaN.

POSITIVE_INFINITY

public static final Speed POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final Speed NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final Speed POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final Speed NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

Speed

public Speed(double value,
             SpeedUnit unit)

Construct Speed scalar.

Parameters:

value - double value

unit - unit for the double value

Speed

public Speed(Speed value)

Construct Speed scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateRel

public final Speed instantiateRel(double value,
                                  SpeedUnit unit)

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

Specified by:

instantiateRel in class AbstractDoubleScalarRel<SpeedUnit,Speed>

Parameters:

value - double; the double value

unit - U; the unit

Returns:

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

createSI

public static final Speed createSI(double value)

Construct Speed scalar.

Parameters:

value - double value in SI units

Returns:

the new scalar with the SI value

interpolate

public static Speed interpolate(Speed zero,
                                Speed one,
                                double 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 Speed max(Speed r1,
                        Speed 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 Speed max(Speed r1,
                        Speed r2,
                        Speed... 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 Speed min(Speed r1,
                        Speed 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 Speed min(Speed r1,
                        Speed r2,
                        Speed... 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 Speed valueOf(String text)
                     throws IllegalArgumentException

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

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 Dimensionless divideBy(Speed v)

Calculate the division of Speed and Speed, which results in a Dimensionless scalar.

Parameters:

v - Speed scalar

Returns:

Dimensionless scalar as a division of Speed and Speed

multiplyBy

public final FlowVolume multiplyBy(Area v)

Calculate the multiplication of Speed and Area, which results in a FlowVolume scalar.

Parameters:

v - Speed scalar

Returns:

FlowVolume scalar as a multiplication of Speed and Area

multiplyBy

public final Power multiplyBy(Force v)

Calculate the multiplication of Speed and Force, which results in a Power scalar.

Parameters:

v - Speed scalar

Returns:

Power scalar as a multiplication of Speed and Force

multiplyBy

public final Acceleration multiplyBy(Frequency v)

Calculate the multiplication of Speed and Frequency, which results in a Acceleration scalar.

Parameters:

v - Speed scalar

Returns:

Acceleration scalar as a multiplication of Speed and Frequency

divideBy

public final Frequency divideBy(Length v)

Calculate the division of Speed and Length, which results in a Frequency scalar.

Parameters:

v - Speed scalar

Returns:

Frequency scalar as a division of Speed and Length

divideBy

public final Length divideBy(Frequency v)

Calculate the division of Speed and Frequency, which results in a Length scalar.

Parameters:

v - Speed scalar

Returns:

Length scalar as a division of Speed and Frequency

multiplyBy

public final Frequency multiplyBy(LinearDensity v)

Calculate the multiplication of Speed and LinearDensity, which results in a Frequency scalar.

Parameters:

v - Speed scalar

Returns:

Frequency scalar as a multiplication of Speed and LinearDensity

multiplyBy

public final Length multiplyBy(Duration v)

Calculate the multiplication of Speed and Duration, which results in a Length scalar.

Parameters:

v - Speed scalar

Returns:

Length scalar as a multiplication of Speed and Duration

divideBy

public final Acceleration divideBy(Duration v)

Calculate the division of Speed and Duration, which results in a Acceleration scalar.

Parameters:

v - Speed scalar

Returns:

Acceleration scalar as a division of Speed and Duration

divideBy

public final Duration divideBy(Acceleration v)

Calculate the division of Speed and Acceleration, which results in a Duration scalar.

Parameters:

v - Speed scalar

Returns:

Duration scalar as a division of Speed and Acceleration

multiplyBy

public final Force multiplyBy(FlowMass v)

Calculate the multiplication of Speed and FlowMass, which results in a Force scalar.

Parameters:

v - Speed scalar

Returns:

Force scalar as a multiplication of Speed and FlowMass