org.djunits.value.vfloat.scalar

Class FloatVolume

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<VolumeUnit,FloatVolume>

org.djunits.value.vfloat.scalar.FloatVolume

All Implemented Interfaces:

Serializable, Comparable<FloatVolume>, MathFunctionsAbs<FloatVolume>, MathFunctionsRel<FloatVolume>, Relative, Value<VolumeUnit>, FloatMathFunctions<FloatVolume>, FloatScalarInterface

public class FloatVolume
extends AbstractFloatScalarRel<VolumeUnit,FloatVolume>

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

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

we can now write:

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

Method Summary

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

constant with value zero.

NaN

public static final FloatVolume NaN

constant with value NaN.

POSITIVE_INFINITY

public static final FloatVolume POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatVolume NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatVolume POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatVolume NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

FloatVolume

public FloatVolume(float value,
                   VolumeUnit unit)

Construct FloatVolume scalar.

Parameters:

value - float value

unit - unit for the float value

FloatVolume

public FloatVolume(FloatVolume value)

Construct FloatVolume scalar.

Parameters:

value - Scalar from which to construct this instance

FloatVolume

public FloatVolume(double value,
                   VolumeUnit unit)

Construct FloatVolume scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

Method Detail

instantiateRel

public final FloatVolume instantiateRel(float value,
                                        VolumeUnit unit)

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

Specified by:

instantiateRel in class AbstractFloatScalarRel<VolumeUnit,FloatVolume>

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

Construct FloatVolume scalar.

Parameters:

value - float value in SI units

Returns:

the new scalar with the SI value

interpolate

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

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

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

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

Parameters:

v - FloatVolume scalar

Returns:

FloatDimensionless scalar as a division of FloatVolume and FloatVolume

multiplyBy

public final FloatMass multiplyBy(FloatDensity v)

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

Parameters:

v - FloatVolume scalar

Returns:

FloatMass scalar as a multiplication of FloatVolume and FloatDensity

multiplyBy

public final FloatEnergy multiplyBy(FloatPressure v)

Calculate the multiplication of FloatVolume and FloatPressure, which results in a FloatEnergy scalar.

Parameters:

v - FloatVolume scalar

Returns:

FloatEnergy scalar as a multiplication of FloatVolume and FloatPressure

divideBy

public final FloatArea divideBy(FloatLength v)

Calculate the division of FloatVolume and FloatLength, which results in a FloatArea scalar.

Parameters:

v - FloatVolume scalar

Returns:

FloatArea scalar as a division of FloatVolume and FloatLength

divideBy

public final FloatLength divideBy(FloatArea v)

Calculate the division of FloatVolume and FloatArea, which results in a FloatLength scalar.

Parameters:

v - FloatVolume scalar

Returns:

FloatLength scalar as a division of FloatVolume and FloatArea

multiplyBy

public final FloatArea multiplyBy(FloatLinearDensity v)

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

Parameters:

v - FloatVolume scalar

Returns:

FloatArea scalar as a multiplication of FloatVolume and FloatLinearDensity

divideBy

public final FloatFlowVolume divideBy(FloatDuration v)

Calculate the division of FloatVolume and FloatDuration, which results in a FloatFlowVolume scalar.

Parameters:

v - FloatVolume scalar

Returns:

FloatFlowVolume scalar as a division of FloatVolume and FloatDuration

divideBy

public final FloatDuration divideBy(FloatFlowVolume v)

Calculate the division of FloatVolume and FloatFlowVolume, which results in a FloatDuration scalar.

Parameters:

v - FloatVolume scalar

Returns:

FloatDuration scalar as a division of FloatVolume and FloatFlowVolume

multiplyBy

public final FloatMoney multiplyBy(FloatMoneyPerVolume v)

Calculate the multiplication of FloatVolume and FloatMoneyPerVolume, which results in a FloatMoney scalar.

Parameters:

v - FloatVolume scalar

Returns:

FloatMoney scalar as a multiplication of FloatVolume and FloatMoneyPerVolume