org.djunits.value.vdouble.scalar

Class Density

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<DensityUnit,Density>

org.djunits.value.vdouble.scalar.Density

All Implemented Interfaces:

Serializable, Comparable<Density>, MathFunctionsAbs<Density>, MathFunctionsRel<Density>, Relative, Value<DensityUnit>, DoubleMathFunctions<Density>, DoubleScalarInterface

public class Density
extends AbstractDoubleScalarRel<DensityUnit,Density>

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

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

we can now write:

 Density value = new Density(100.0, DensityUnit.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-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

$LastChangedDate: 2018-01-28 03:17:44 +0100 (Sun, 28 Jan 2018) $, @version $Revision: 256 $, 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 Density	NaN constant with value NaN.
static Density	NEG_MAXVALUE constant with value -MAX_VALUE.
static Density	NEGATIVE_INFINITY constant with value NEGATIVE_INFINITY.
static Density	POS_MAXVALUE constant with value MAX_VALUE.
static Density	POSITIVE_INFINITY constant with value POSITIVE_INFINITY.
static Density	ZERO constant with value zero.

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

si

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
Density(Density value) Construct Density scalar.
Density(double value, DensityUnit unit) Construct Density scalar.

Method Summary

Modifier and Type	Method and Description
static Density	createSI(double value) Construct Density scalar.
Dimensionless	divideBy(Density v) Calculate the division of Density and Density, which results in a Dimensionless scalar.
Density	instantiateRel(double value, DensityUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
static Density	interpolate(Density zero, Density one, double ratio) Interpolate between two values.
static Density	max(Density r1, Density r2) Return the maximum value of two relative scalars.
static Density	max(Density r1, Density r2, Density... rn) Return the maximum value of more than two relative scalars.
static Density	min(Density r1, Density r2) Return the minimum value of two relative scalars.
static Density	min(Density r1, Density r2, Density... rn) Return the minimum value of more than two relative scalars.
Mass	multiplyBy(Volume v) Calculate the multiplication of Density and Volume, which results in a Mass scalar.

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

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

constant with value zero.

NaN

public static final Density NaN

constant with value NaN.

POSITIVE_INFINITY

public static final Density POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final Density NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final Density POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final Density NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

Density

public Density(double value,
               DensityUnit unit)

Construct Density scalar.

Parameters:

value - double value

unit - unit for the double value

Density

public Density(Density value)

Construct Density scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateRel

public final Density instantiateRel(double value,
                                    DensityUnit unit)

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

Specified by:

instantiateRel in class AbstractDoubleScalarRel<DensityUnit,Density>

Parameters:

value - the double value

unit - the unit

Returns:

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

createSI

public static final Density createSI(double value)

Construct Density scalar.

Parameters:

value - double value in SI units

Returns:

the new scalar with the SI value

interpolate

public static Density interpolate(Density zero,
                                  Density 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 Density max(Density r1,
                          Density 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 Density max(Density r1,
                          Density r2,
                          Density... 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 Density min(Density r1,
                          Density 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 Density min(Density r1,
                          Density r2,
                          Density... 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

divideBy

public final Dimensionless divideBy(Density v)

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

Parameters:

v - Density scalar

Returns:

Dimensionless scalar as a division of Density and Density

multiplyBy

public final Mass multiplyBy(Volume v)

Calculate the multiplication of Density and Volume, which results in a Mass scalar.

Parameters:

v - Density scalar

Returns:

Mass scalar as a multiplication of Density and Volume