Package org.djunits.value.vdouble.scalar

Class Acceleration

java.lang.Object

java.lang.Number

org.djunits.value.base.Scalar<U,S>

org.djunits.value.vdouble.scalar.base.DoubleScalar<U,R>

org.djunits.value.vdouble.scalar.base.DoubleScalarRel<AccelerationUnit,Acceleration>

org.djunits.value.vdouble.scalar.Acceleration

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Acceleration>, Relative<AccelerationUnit,Acceleration>, Value<AccelerationUnit,Acceleration>

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

Easy access methods for the Acceleration DoubleScalar, 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 Acceleration	NaN	Constant with value NaN.
static final Acceleration	NEG_MAXVALUE	Constant with value -MAX_VALUE.
static final Acceleration	NEGATIVE_INFINITY	Constant with value NEGATIVE_INFINITY.
static final Acceleration	ONE	Constant with value one.
static final Acceleration	POS_MAXVALUE	Constant with value MAX_VALUE.
static final Acceleration	POSITIVE_INFINITY	Constant with value POSITIVE_INFINITY.
static final Acceleration	ZERO	Constant with value zero.

Fields inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar

si

Constructor Summary

Constructors

Constructor	Description
Acceleration(double value, AccelerationUnit unit)	Construct Acceleration scalar.
Acceleration(Acceleration value)	Construct Acceleration scalar.

Method Summary

Modifier and Type	Method	Description
final Dimensionless	divide(Acceleration v)	Calculate the division of Acceleration and Acceleration, which results in a Dimensionless scalar.
final Speed	divide(Frequency v)	Calculate the division of Acceleration and Frequency, which results in a Speed scalar.
final Frequency	divide(Speed v)	Calculate the division of Acceleration and Speed, which results in a Frequency scalar.
final Acceleration	instantiateRel(double value, AccelerationUnit unit)	Construct a new Relative Immutable DoubleScalar of the right type.
static final Acceleration	instantiateSI(double value)	Construct Acceleration scalar.
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.
static Acceleration	of(double value, String unitString)	Returns a Acceleration based on a value and the textual representation of the unit, which can be localized.
SIScalar	reciprocal()	Create the reciprocal of this scalar with the correct dimensions.
final Speed	times(Duration v)	Calculate the multiplication of Acceleration and Duration, which results in a Speed scalar.
final Force	times(Mass v)	Calculate the multiplication of Acceleration and Mass, which results in a Force scalar.
final Power	times(Momentum v)	Calculate the multiplication of Acceleration and Momentum, which results in a Power 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.base.DoubleScalarRel

abs, ceil, divide, divide, divide, floor, minus, neg, plus, rint, times, times, times

Methods inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar

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 Acceleration ZERO

Constant with value zero.

ONE

public static final Acceleration ONE

Constant with value one.

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 Details

Acceleration

public Acceleration(double value,
 AccelerationUnit unit)

Construct Acceleration scalar.

Parameters:

value - double; the double value

unit - AccelerationUnit; unit for the double value

Acceleration

public Acceleration(Acceleration value)

Construct Acceleration scalar.

Parameters:

value - Acceleration; Scalar from which to construct this instance

Method Details

instantiateRel

public final Acceleration instantiateRel(double value,
 AccelerationUnit unit)

Description copied from class: DoubleScalarRel

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

Specified by:

instantiateRel in class DoubleScalarRel<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

instantiateSI

public static final Acceleration instantiateSI(double value)

Construct Acceleration scalar.

Parameters:

value - double; the double value in SI units

Returns:

Acceleration; the new scalar with the SI value

interpolate

public static Acceleration interpolate(Acceleration zero,
 Acceleration one,
 double ratio)

Interpolate between two values.

Parameters:

zero - Acceleration; the low value

one - Acceleration; the high value

ratio - double; the ratio between 0 and 1, inclusive

Returns:

Acceleration; 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 - Acceleration; the first scalar

r2 - Acceleration; the second scalar

Returns:

Acceleration; 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 - Acceleration; the first scalar

r2 - Acceleration; the second scalar

rn - Acceleration...; the other scalars

Returns:

Acceleration; 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 - Acceleration; the first scalar

r2 - Acceleration; the second scalar

Returns:

Acceleration; 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 - Acceleration; the first scalar

r2 - Acceleration; the second scalar

rn - Acceleration...; the other scalars

Returns:

Acceleration; the minimum value of more than two relative scalars

valueOf

public static Acceleration valueOf(String text)

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

Returns:

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

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

Acceleration; 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 Dimensionless divide(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

times

public final Force times(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

times

public final Speed times(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

divide

public final Speed divide(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

divide

public final Frequency divide(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

times

public final Power times(Momentum v)

Calculate the multiplication of Acceleration and Momentum, which results in a Power scalar.

Parameters:

v - Acceleration; scalar

Returns:

Power; scalar as a multiplication of Acceleration and Momentum

reciprocal

public SIScalar reciprocal()

Description copied from class: DoubleScalarRel

Create the reciprocal of this scalar with the correct dimensions.

Specified by:

reciprocal in class DoubleScalarRel<AccelerationUnit,Acceleration>

Returns:

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