org.djunits.value.vfloat.scalar

Class FloatLinearDensity

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

org.djunits.value.vfloat.scalar.FloatLinearDensity

All Implemented Interfaces:

Serializable, Comparable<FloatLinearDensity>, MathFunctionsAbs<FloatLinearDensity>, MathFunctionsRel<FloatLinearDensity>, Relative, Value<LinearDensityUnit>, FloatMathFunctions<FloatLinearDensity>, FloatScalarInterface

public class FloatLinearDensity
extends AbstractFloatScalarRel<LinearDensityUnit,FloatLinearDensity>

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

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

we can now write:

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

Method Summary

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

constant with value zero.

NaN

public static final FloatLinearDensity NaN

constant with value NaN.

POSITIVE_INFINITY

public static final FloatLinearDensity POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatLinearDensity NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatLinearDensity POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatLinearDensity NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

FloatLinearDensity

public FloatLinearDensity(float value,
                          LinearDensityUnit unit)

Construct FloatLinearDensity scalar.

Parameters:

value - float value

unit - unit for the float value

FloatLinearDensity

public FloatLinearDensity(FloatLinearDensity value)

Construct FloatLinearDensity scalar.

Parameters:

value - Scalar from which to construct this instance

FloatLinearDensity

public FloatLinearDensity(double value,
                          LinearDensityUnit unit)

Construct FloatLinearDensity scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

Method Detail

instantiateRel

public final FloatLinearDensity instantiateRel(float value,
                                               LinearDensityUnit unit)

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

Specified by:

instantiateRel in class AbstractFloatScalarRel<LinearDensityUnit,FloatLinearDensity>

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

Construct FloatLinearDensity scalar.

Parameters:

value - float value in SI units

Returns:

the new scalar with the SI value

interpolate

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

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

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

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

Parameters:

v - FloatLinearDensity scalar

Returns:

FloatDimensionless scalar as a division of FloatLinearDensity and FloatLinearDensity

multiplyBy

public final FloatLength multiplyBy(FloatArea v)

Calculate the multiplication of FloatLinearDensity and FloatArea, which results in a FloatLength scalar.

Parameters:

v - FloatLinearDensity scalar

Returns:

FloatLength scalar as a multiplication of FloatLinearDensity and FloatArea

multiplyBy

public final FloatForce multiplyBy(FloatEnergy v)

Calculate the multiplication of FloatLinearDensity and FloatEnergy, which results in a FloatForce scalar.

Parameters:

v - FloatLinearDensity scalar

Returns:

FloatForce scalar as a multiplication of FloatLinearDensity and FloatEnergy

multiplyBy

public final FloatFrequency multiplyBy(FloatSpeed v)

Calculate the multiplication of FloatLinearDensity and FloatSpeed, which results in a FloatFrequency scalar.

Parameters:

v - FloatLinearDensity scalar

Returns:

FloatFrequency scalar as a multiplication of FloatLinearDensity and FloatSpeed

multiplyBy

public final FloatMoneyPerLength multiplyBy(FloatMoney v)

Calculate the multiplication of FloatLinearDensity and FloatMoney, which results in a FloatMoneyPerLength scalar.

Parameters:

v - FloatLinearDensity scalar

Returns:

FloatMoneyPerLength scalar as a multiplication of FloatLinearDensity and FloatMoney