org.djunits.value.vdouble.scalar

Class LinearDensity

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<LinearDensityUnit,LinearDensity>

org.djunits.value.vdouble.scalar.LinearDensity

All Implemented Interfaces:

Serializable, Comparable<LinearDensity>, MathFunctionsAbs<LinearDensity>, MathFunctionsRel<LinearDensity>, Relative, Value<LinearDensityUnit>, DoubleMathFunctions<LinearDensity>, DoubleScalarInterface

public class LinearDensity
extends AbstractDoubleScalarRel<LinearDensityUnit,LinearDensity>

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

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

we can now write:

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

Method Summary

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

constant with value zero.

NaN

public static final LinearDensity NaN

constant with value NaN.

POSITIVE_INFINITY

public static final LinearDensity POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final LinearDensity NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final LinearDensity POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final LinearDensity NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

LinearDensity

public LinearDensity(double value,
                     LinearDensityUnit unit)

Construct LinearDensity scalar.

Parameters:

value - double value

unit - unit for the double value

LinearDensity

public LinearDensity(LinearDensity value)

Construct LinearDensity scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateRel

public final LinearDensity instantiateRel(double value,
                                          LinearDensityUnit unit)

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

Specified by:

instantiateRel in class AbstractDoubleScalarRel<LinearDensityUnit,LinearDensity>

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

Construct LinearDensity scalar.

Parameters:

value - double value in SI units

Returns:

the new scalar with the SI value

interpolate

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

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

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

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

Parameters:

v - LinearDensity scalar

Returns:

Dimensionless scalar as a division of LinearDensity and LinearDensity

multiplyBy

public final Length multiplyBy(Area v)

Calculate the multiplication of LinearDensity and Area, which results in a Length scalar.

Parameters:

v - LinearDensity scalar

Returns:

Length scalar as a multiplication of LinearDensity and Area

multiplyBy

public final Force multiplyBy(Energy v)

Calculate the multiplication of LinearDensity and Energy, which results in a Force scalar.

Parameters:

v - LinearDensity scalar

Returns:

Force scalar as a multiplication of LinearDensity and Energy

multiplyBy

public final Frequency multiplyBy(Speed v)

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

Parameters:

v - LinearDensity scalar

Returns:

Frequency scalar as a multiplication of LinearDensity and Speed

multiplyBy

public final MoneyPerLength multiplyBy(Money v)

Calculate the multiplication of LinearDensity and Money, which results in a MoneyPerLength scalar.

Parameters:

v - LinearDensity scalar

Returns:

MoneyPerLength scalar as a multiplication of LinearDensity and Money