org.djunits.value.vfloat.scalar

Class FloatAcceleration

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<AccelerationUnit,FloatAcceleration>

org.djunits.value.vfloat.scalar.FloatAcceleration

All Implemented Interfaces:

Serializable, Comparable<FloatAcceleration>, MathFunctionsAbs<FloatAcceleration>, MathFunctionsRel<FloatAcceleration>, Relative, Value<AccelerationUnit>, FloatMathFunctions<FloatAcceleration>, FloatScalarInterface

public class FloatAcceleration
extends AbstractFloatScalarRel<AccelerationUnit,FloatAcceleration>

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

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

we can now write:

 FloatAcceleration value = new FloatAcceleration(100.0, AccelerationUnit.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 FloatAcceleration	NaN constant with value NaN.
static FloatAcceleration	NEG_MAXVALUE constant with value -MAX_VALUE.
static FloatAcceleration	NEGATIVE_INFINITY constant with value NEGATIVE_INFINITY.
static FloatAcceleration	POS_MAXVALUE constant with value MAX_VALUE.
static FloatAcceleration	POSITIVE_INFINITY constant with value POSITIVE_INFINITY.
static FloatAcceleration	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
FloatAcceleration(double value, AccelerationUnit unit) Construct FloatAcceleration scalar using a double value.
FloatAcceleration(FloatAcceleration value) Construct FloatAcceleration scalar.
FloatAcceleration(float value, AccelerationUnit unit) Construct FloatAcceleration scalar.

Method Summary

Modifier and Type	Method and Description
static FloatAcceleration	createSI(float value) Construct FloatAcceleration scalar.
FloatDimensionless	divideBy(FloatAcceleration v) Calculate the division of FloatAcceleration and FloatAcceleration, which results in a FloatDimensionless scalar.
FloatSpeed	divideBy(FloatFrequency v) Calculate the division of FloatAcceleration and FloatFrequency, which results in a FloatSpeed scalar.
FloatFrequency	divideBy(FloatSpeed v) Calculate the division of FloatAcceleration and FloatSpeed, which results in a FloatFrequency scalar.
FloatAcceleration	instantiateRel(float value, AccelerationUnit unit) Construct a new Relative Immutable FloatScalar of the right type.
static FloatAcceleration	interpolate(FloatAcceleration zero, FloatAcceleration one, float ratio) Interpolate between two values.
static FloatAcceleration	max(FloatAcceleration r1, FloatAcceleration r2) Return the maximum value of two relative scalars.
static FloatAcceleration	max(FloatAcceleration r1, FloatAcceleration r2, FloatAcceleration... rn) Return the maximum value of more than two relative scalars.
static FloatAcceleration	min(FloatAcceleration r1, FloatAcceleration r2) Return the minimum value of two relative scalars.
static FloatAcceleration	min(FloatAcceleration r1, FloatAcceleration r2, FloatAcceleration... rn) Return the minimum value of more than two relative scalars.
FloatSpeed	multiplyBy(FloatDuration v) Calculate the multiplication of FloatAcceleration and FloatDuration, which results in a FloatSpeed scalar.
FloatForce	multiplyBy(FloatMass v) Calculate the multiplication of FloatAcceleration and FloatMass, which results in a FloatForce scalar.
static FloatAcceleration	valueOf(String text) Returns a FloatAcceleration 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 FloatAcceleration ZERO

constant with value zero.

NaN

public static final FloatAcceleration NaN

constant with value NaN.

POSITIVE_INFINITY

public static final FloatAcceleration POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatAcceleration NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatAcceleration POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatAcceleration NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

FloatAcceleration

public FloatAcceleration(float value,
                         AccelerationUnit unit)

Construct FloatAcceleration scalar.

Parameters:

value - float value

unit - unit for the float value

FloatAcceleration

public FloatAcceleration(FloatAcceleration value)

Construct FloatAcceleration scalar.

Parameters:

value - Scalar from which to construct this instance

FloatAcceleration

public FloatAcceleration(double value,
                         AccelerationUnit unit)

Construct FloatAcceleration scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

Method Detail

instantiateRel

public final FloatAcceleration instantiateRel(float value,
                                              AccelerationUnit unit)

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

Specified by:

instantiateRel in class AbstractFloatScalarRel<AccelerationUnit,FloatAcceleration>

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 FloatAcceleration createSI(float value)

Construct FloatAcceleration scalar.

Parameters:

value - float value in SI units

Returns:

the new scalar with the SI value

interpolate

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

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

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(FloatAcceleration v)

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

Parameters:

v - FloatAcceleration scalar

Returns:

FloatDimensionless scalar as a division of FloatAcceleration and FloatAcceleration

multiplyBy

public final FloatForce multiplyBy(FloatMass v)

Calculate the multiplication of FloatAcceleration and FloatMass, which results in a FloatForce scalar.

Parameters:

v - FloatAcceleration scalar

Returns:

FloatForce scalar as a multiplication of FloatAcceleration and FloatMass

multiplyBy

public final FloatSpeed multiplyBy(FloatDuration v)

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

Parameters:

v - FloatAcceleration scalar

Returns:

FloatSpeed scalar as a multiplication of FloatAcceleration and FloatDuration

divideBy

public final FloatSpeed divideBy(FloatFrequency v)

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

Parameters:

v - FloatAcceleration scalar

Returns:

FloatSpeed scalar as a division of FloatAcceleration and FloatFrequency

divideBy

public final FloatFrequency divideBy(FloatSpeed v)

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

Parameters:

v - FloatAcceleration scalar

Returns:

FloatFrequency scalar as a division of FloatAcceleration and FloatSpeed