org.djunits.value.vfloat.scalar

Class FloatDensity

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

org.djunits.value.vfloat.scalar.FloatDensity

All Implemented Interfaces:

Serializable, Comparable<FloatDensity>, MathFunctionsAbs<FloatDensity>, MathFunctionsRel<FloatDensity>, Relative, Value<DensityUnit>, FloatMathFunctions<FloatDensity>, FloatScalarInterface

public class FloatDensity
extends AbstractFloatScalarRel<DensityUnit,FloatDensity>

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

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

we can now write:

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

Method Summary

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

constant with value zero.

NaN

public static final FloatDensity NaN

constant with value NaN.

POSITIVE_INFINITY

public static final FloatDensity POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatDensity NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatDensity POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatDensity NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

FloatDensity

public FloatDensity(float value,
                    DensityUnit unit)

Construct FloatDensity scalar.

Parameters:

value - float value

unit - unit for the float value

FloatDensity

public FloatDensity(FloatDensity value)

Construct FloatDensity scalar.

Parameters:

value - Scalar from which to construct this instance

FloatDensity

public FloatDensity(double value,
                    DensityUnit unit)

Construct FloatDensity scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

Method Detail

instantiateRel

public final FloatDensity instantiateRel(float value,
                                         DensityUnit unit)

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

Specified by:

instantiateRel in class AbstractFloatScalarRel<DensityUnit,FloatDensity>

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

Construct FloatDensity scalar.

Parameters:

value - float value in SI units

Returns:

the new scalar with the SI value

interpolate

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

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

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

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

Parameters:

v - FloatDensity scalar

Returns:

FloatDimensionless scalar as a division of FloatDensity and FloatDensity

multiplyBy

public final FloatMass multiplyBy(FloatVolume v)

Calculate the multiplication of FloatDensity and FloatVolume, which results in a FloatMass scalar.

Parameters:

v - FloatDensity scalar

Returns:

FloatMass scalar as a multiplication of FloatDensity and FloatVolume