org.djunits.value.vdouble.scalar

Class Acceleration

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

org.djunits.value.vdouble.scalar.Acceleration

All Implemented Interfaces:

Serializable, Comparable<Acceleration>, MathFunctionsAbs<Acceleration>, MathFunctionsRel<Acceleration>, Relative, Value<AccelerationUnit>, DoubleMathFunctions<Acceleration>, DoubleScalarInterface

public class Acceleration
extends AbstractDoubleScalarRel<AccelerationUnit,Acceleration>

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

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

we can now write:

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

Method Summary

Modifier and Type	Method and Description
static Acceleration	createSI(double value) Construct Acceleration scalar.
Dimensionless	divideBy(Acceleration v) Calculate the division of Acceleration and Acceleration, which results in a Dimensionless scalar.
Speed	divideBy(Frequency v) Calculate the division of Acceleration and Frequency, which results in a Speed scalar.
Frequency	divideBy(Speed v) Calculate the division of Acceleration and Speed, which results in a Frequency scalar.
Acceleration	instantiateRel(double value, AccelerationUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
static Acceleration	interpolate(Acceleration zero, Acceleration one, double ratio) Interpolate between two values.
static Acceleration	max(Acceleration r1, Acceleration r2) Return the maximum value of two relative scalars.
static Acceleration	max(Acceleration r1, Acceleration r2, Acceleration... rn) Return the maximum value of more than two relative scalars.
static Acceleration	min(Acceleration r1, Acceleration r2) Return the minimum value of two relative scalars.
static Acceleration	min(Acceleration r1, Acceleration r2, Acceleration... rn) Return the minimum value of more than two relative scalars.
Speed	multiplyBy(Duration v) Calculate the multiplication of Acceleration and Duration, which results in a Speed scalar.
Force	multiplyBy(Mass v) Calculate the multiplication of Acceleration and Mass, which results in a Force scalar.
static Acceleration	valueOf(String text) Returns a Acceleration 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 Acceleration ZERO

constant with value zero.

NaN

public static final Acceleration NaN

constant with value NaN.

POSITIVE_INFINITY

public static final Acceleration POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final Acceleration NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final Acceleration POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final Acceleration NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

Acceleration

public Acceleration(double value,
                    AccelerationUnit unit)

Construct Acceleration scalar.

Parameters:

value - double value

unit - unit for the double value

Acceleration

public Acceleration(Acceleration value)

Construct Acceleration scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateRel

public final Acceleration instantiateRel(double value,
                                         AccelerationUnit unit)

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

Specified by:

instantiateRel in class AbstractDoubleScalarRel<AccelerationUnit,Acceleration>

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 Acceleration createSI(double value)

Construct Acceleration scalar.

Parameters:

value - double value in SI units

Returns:

the new scalar with the SI value

interpolate

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

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

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

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

Parameters:

v - Acceleration scalar

Returns:

Dimensionless scalar as a division of Acceleration and Acceleration

multiplyBy

public final Force multiplyBy(Mass v)

Calculate the multiplication of Acceleration and Mass, which results in a Force scalar.

Parameters:

v - Acceleration scalar

Returns:

Force scalar as a multiplication of Acceleration and Mass

multiplyBy

public final Speed multiplyBy(Duration v)

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

Parameters:

v - Acceleration scalar

Returns:

Speed scalar as a multiplication of Acceleration and Duration

divideBy

public final Speed divideBy(Frequency v)

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

Parameters:

v - Acceleration scalar

Returns:

Speed scalar as a division of Acceleration and Frequency

divideBy

public final Frequency divideBy(Speed v)

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

Parameters:

v - Acceleration scalar

Returns:

Frequency scalar as a division of Acceleration and Speed