Package org.djunits.value.vfloat.scalar

Class FloatAmountOfSubstance

java.lang.Object

java.lang.Number

org.djunits.value.base.Scalar<U,S>

org.djunits.value.vfloat.scalar.base.FloatScalar<U,R>

org.djunits.value.vfloat.scalar.base.FloatScalarRel<AmountOfSubstanceUnit,FloatAmountOfSubstance>

org.djunits.value.vfloat.scalar.FloatAmountOfSubstance

All Implemented Interfaces:

Serializable, Cloneable, Comparable<FloatAmountOfSubstance>, Relative<AmountOfSubstanceUnit,FloatAmountOfSubstance>, Value<AmountOfSubstanceUnit,FloatAmountOfSubstance>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-07-23T14:06:38.224104100Z")
public class FloatAmountOfSubstance
extends FloatScalarRel<AmountOfSubstanceUnit,FloatAmountOfSubstance>

Easy access methods for the FloatAmountOfSubstance FloatScalar, which is relative by definition.

Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final FloatAmountOfSubstance	NaN	Constant with value NaN.
static final FloatAmountOfSubstance	NEG_MAXVALUE	Constant with value -MAX_VALUE.
static final FloatAmountOfSubstance	NEGATIVE_INFINITY	Constant with value NEGATIVE_INFINITY.
static final FloatAmountOfSubstance	ONE	Constant with value one.
static final FloatAmountOfSubstance	POS_MAXVALUE	Constant with value MAX_VALUE.
static final FloatAmountOfSubstance	POSITIVE_INFINITY	Constant with value POSITIVE_INFINITY.
static final FloatAmountOfSubstance	ZERO	Constant with value zero.

Fields inherited from class org.djunits.value.vfloat.scalar.base.FloatScalar

si

Constructor Summary

Constructors

Constructor	Description
FloatAmountOfSubstance(double value, AmountOfSubstanceUnit unit)	Construct FloatAmountOfSubstance scalar using a double value.
FloatAmountOfSubstance(float value, AmountOfSubstanceUnit unit)	Construct FloatAmountOfSubstance scalar.
FloatAmountOfSubstance(FloatAmountOfSubstance value)	Construct FloatAmountOfSubstance scalar.

Method Summary

Modifier and Type	Method	Description
final FloatDimensionless	divide(FloatAmountOfSubstance v)	Calculate the division of FloatAmountOfSubstance and FloatAmountOfSubstance, which results in a FloatDimensionless scalar.
final FloatDuration	divide(FloatCatalyticActivity v)	Calculate the division of FloatAmountOfSubstance and FloatCatalyticActivity, which results in a FloatDuration scalar.
final FloatCatalyticActivity	divide(FloatDuration v)	Calculate the division of FloatAmountOfSubstance and FloatDuration, which results in a FloatCatalyticActivity scalar.
final FloatAmountOfSubstance	instantiateRel(float value, AmountOfSubstanceUnit unit)	Construct a new Relative Immutable FloatScalar of the right type.
static final FloatAmountOfSubstance	instantiateSI(float value)	Construct FloatAmountOfSubstance scalar.
static FloatAmountOfSubstance	interpolate(FloatAmountOfSubstance zero, FloatAmountOfSubstance one, float ratio)	Interpolate between two values.
static FloatAmountOfSubstance	max(FloatAmountOfSubstance r1, FloatAmountOfSubstance r2)	Return the maximum value of two relative scalars.
static FloatAmountOfSubstance	max(FloatAmountOfSubstance r1, FloatAmountOfSubstance r2, FloatAmountOfSubstance... rn)	Return the maximum value of more than two relative scalars.
static FloatAmountOfSubstance	min(FloatAmountOfSubstance r1, FloatAmountOfSubstance r2)	Return the minimum value of two relative scalars.
static FloatAmountOfSubstance	min(FloatAmountOfSubstance r1, FloatAmountOfSubstance r2, FloatAmountOfSubstance... rn)	Return the minimum value of more than two relative scalars.
static FloatAmountOfSubstance	of(float value, String unitString)	Returns a FloatAmountOfSubstance based on a value and the textual representation of the unit, which can be localized.
FloatSIScalar	reciprocal()	Create the reciprocal of this scalar with the correct dimensions.
static FloatAmountOfSubstance	valueOf(String text)	Returns a FloatAmountOfSubstance representation of a textual representation of a value with a unit.

Methods inherited from class org.djunits.value.vfloat.scalar.base.FloatScalarRel

abs, ceil, divide, divide, divide, floor, minus, neg, plus, rint, times, times, times

Methods inherited from class org.djunits.value.vfloat.scalar.base.FloatScalar

compareTo, divide, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, instantiate, instantiateAnonymous, instantiateSI, interpolate, interpolate, intValue, le, le0, longValue, lt, lt0, max, max, min, min, minus, minus, minus, multiply, ne, ne0, plus, plus, plus, toDisplayString, toDisplayString, toString, toString, toString, toString, toStringSIPrefixed, toStringSIPrefixed, toTextualString, toTextualString

Methods inherited from class org.djunits.value.base.Scalar

format, format, getDisplayUnit, 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.Value

isAbsolute, isRelative

Field Details

ZERO

public static final FloatAmountOfSubstance ZERO

Constant with value zero.

ONE

public static final FloatAmountOfSubstance ONE

Constant with value one.

NaN

public static final FloatAmountOfSubstance NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final FloatAmountOfSubstance POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatAmountOfSubstance NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatAmountOfSubstance POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatAmountOfSubstance NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

FloatAmountOfSubstance

public FloatAmountOfSubstance(float value,
 AmountOfSubstanceUnit unit)

Construct FloatAmountOfSubstance scalar.

Parameters:

value - float; the float value

unit - unit for the float value

FloatAmountOfSubstance

public FloatAmountOfSubstance(FloatAmountOfSubstance value)

Construct FloatAmountOfSubstance scalar.

Parameters:

value - Scalar from which to construct this instance

FloatAmountOfSubstance

public FloatAmountOfSubstance(double value,
 AmountOfSubstanceUnit unit)

Construct FloatAmountOfSubstance scalar using a double value.

Parameters:

value - double; the double value

unit - unit for the resulting float value

Method Details

instantiateRel

public final FloatAmountOfSubstance instantiateRel(float value,
 AmountOfSubstanceUnit unit)

Description copied from class: FloatScalarRel

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

Specified by:

instantiateRel in class FloatScalarRel<AmountOfSubstanceUnit,FloatAmountOfSubstance>

Parameters:

value - float; the float value

unit - U; the unit

Returns:

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

instantiateSI

public static final FloatAmountOfSubstance instantiateSI(float value)

Construct FloatAmountOfSubstance scalar.

Parameters:

value - float; the float value in SI units

Returns:

the new scalar with the SI value

interpolate

public static FloatAmountOfSubstance interpolate(FloatAmountOfSubstance zero,
 FloatAmountOfSubstance one,
 float ratio)

Interpolate between two values.

Parameters:

zero - the low value

one - the high value

ratio - double; the ratio between 0 and 1, inclusive

Returns:

a Scalar at the ratio between

max

public static FloatAmountOfSubstance max(FloatAmountOfSubstance r1,
 FloatAmountOfSubstance 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 FloatAmountOfSubstance max(FloatAmountOfSubstance r1,
 FloatAmountOfSubstance r2,
 FloatAmountOfSubstance... 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 FloatAmountOfSubstance min(FloatAmountOfSubstance r1,
 FloatAmountOfSubstance 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 FloatAmountOfSubstance min(FloatAmountOfSubstance r1,
 FloatAmountOfSubstance r2,
 FloatAmountOfSubstance... 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 FloatAmountOfSubstance valueOf(String text)

Returns a FloatAmountOfSubstance 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 a localized or English abbreviation of the unit. Spaces are allowed, but not required, between the value and the unit.

Parameters:

text - String; the textual representation to parse into a FloatAmountOfSubstance

Returns:

FloatAmountOfSubstance; the Scalar representation of the value in its unit

Throws:

IllegalArgumentException - when the text cannot be parsed

NullPointerException - when the text argument is null

of

public static FloatAmountOfSubstance of(float value,
 String unitString)

Returns a FloatAmountOfSubstance based on a value and the textual representation of the unit, which can be localized.

Parameters:

value - double; the value to use

unitString - String; the textual representation of the unit

Returns:

FloatAmountOfSubstance; the Scalar representation of the value in its unit

Throws:

IllegalArgumentException - when the unit cannot be parsed or is incorrect

NullPointerException - when the unitString argument is null

divide

public final FloatDimensionless divide(FloatAmountOfSubstance v)

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

Parameters:

v - FloatAmountOfSubstance; scalar

Returns:

FloatDimensionless; scalar as a division of FloatAmountOfSubstance and FloatAmountOfSubstance

divide

public final FloatDuration divide(FloatCatalyticActivity v)

Calculate the division of FloatAmountOfSubstance and FloatCatalyticActivity, which results in a FloatDuration scalar.

Parameters:

v - FloatAmountOfSubstance; scalar

Returns:

FloatDuration; scalar as a division of FloatAmountOfSubstance and FloatCatalyticActivity

divide

public final FloatCatalyticActivity divide(FloatDuration v)

Calculate the division of FloatAmountOfSubstance and FloatDuration, which results in a FloatCatalyticActivity scalar.

Parameters:

v - FloatAmountOfSubstance; scalar

Returns:

FloatCatalyticActivity; scalar as a division of FloatAmountOfSubstance and FloatDuration

reciprocal

public FloatSIScalar reciprocal()

Description copied from class: FloatScalarRel

Create the reciprocal of this scalar with the correct dimensions.

Specified by:

reciprocal in class FloatScalarRel<AmountOfSubstanceUnit,FloatAmountOfSubstance>

Returns:

FloatScalar<?>; a new scalar instance with correct SI dimensions