Package org.djunits.value.vdouble.scalar

Class AmountOfSubstance

java.lang.Object

java.lang.Number

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

org.djunits.value.vdouble.scalar.base.DoubleScalar<U,R>

org.djunits.value.vdouble.scalar.base.DoubleScalarRel<AmountOfSubstanceUnit,AmountOfSubstance>

org.djunits.value.vdouble.scalar.AmountOfSubstance

All Implemented Interfaces:

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

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2025-09-06T15:16:28.380798Z")
public class AmountOfSubstance
extends DoubleScalarRel<AmountOfSubstanceUnit,AmountOfSubstance>

Easy access methods for the AmountOfSubstance DoubleScalar, which is relative by definition.

Copyright (c) 2013-2025 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 AmountOfSubstance	NaN	Constant with value NaN.
static final AmountOfSubstance	NEG_MAXVALUE	Constant with value -MAX_VALUE.
static final AmountOfSubstance	NEGATIVE_INFINITY	Constant with value NEGATIVE_INFINITY.
static final AmountOfSubstance	ONE	Constant with value one.
static final AmountOfSubstance	POS_MAXVALUE	Constant with value MAX_VALUE.
static final AmountOfSubstance	POSITIVE_INFINITY	Constant with value POSITIVE_INFINITY.
static final AmountOfSubstance	ZERO	Constant with value zero.

Fields inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar

si

Constructor Summary

Constructors

Constructor	Description
AmountOfSubstance(double value, AmountOfSubstanceUnit unit)	Construct AmountOfSubstance scalar with a unit.
AmountOfSubstance(AmountOfSubstance value)	Construct AmountOfSubstance scalar.

Method Summary

Modifier and Type	Method	Description
final Dimensionless	divide(AmountOfSubstance v)	Calculate the division of AmountOfSubstance and AmountOfSubstance, which results in a Dimensionless scalar.
static AmountOfSubstance	divide(DoubleScalarRel<?,?> scalar1, DoubleScalarRel<?,?> scalar2)	Divide two scalars that result in a scalar of type AmountOfSubstance.
final Duration	divide(CatalyticActivity v)	Calculate the division of AmountOfSubstance and CatalyticActivity, which results in a Duration scalar.
final CatalyticActivity	divide(Duration v)	Calculate the division of AmountOfSubstance and Duration, which results in a CatalyticActivity scalar.
final AmountOfSubstance	instantiateRel(double value, AmountOfSubstanceUnit unit)	Construct a new Relative Immutable DoubleScalar of the right type.
static AmountOfSubstance	interpolate(AmountOfSubstance zero, AmountOfSubstance one, double ratio)	Interpolate between two values.
static AmountOfSubstance	max(AmountOfSubstance r1, AmountOfSubstance r2)	Return the maximum value of two relative scalars.
static AmountOfSubstance	max(AmountOfSubstance r1, AmountOfSubstance r2, AmountOfSubstance... rn)	Return the maximum value of more than two relative scalars.
static AmountOfSubstance	min(AmountOfSubstance r1, AmountOfSubstance r2)	Return the minimum value of two relative scalars.
static AmountOfSubstance	min(AmountOfSubstance r1, AmountOfSubstance r2, AmountOfSubstance... rn)	Return the minimum value of more than two relative scalars.
static AmountOfSubstance	multiply(DoubleScalarRel<?,?> scalar1, DoubleScalarRel<?,?> scalar2)	Multiply two scalars that result in a scalar of type AmountOfSubstance.
static AmountOfSubstance	of(double value, String unitString)	Returns a AmountOfSubstance based on a value and the textual representation of the unit, which can be localized.
static final AmountOfSubstance	ofSI(double value)	Construct AmountOfSubstance scalar based on an SI value.
SIScalar	reciprocal()	Create the reciprocal of this scalar with the correct dimensions.
static AmountOfSubstance	valueOf(String text)	Returns a AmountOfSubstance representation of a textual representation of a value with a unit.

Methods inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalarRel

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

Methods inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar

compareTo, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, intValue, le, le0, longValue, lt, lt0, ne, ne0, 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 AmountOfSubstance ZERO

Constant with value zero.

ONE

public static final AmountOfSubstance ONE

Constant with value one.

NaN

public static final AmountOfSubstance NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final AmountOfSubstance POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final AmountOfSubstance NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final AmountOfSubstance POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final AmountOfSubstance NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

AmountOfSubstance

public AmountOfSubstance(double value,
 AmountOfSubstanceUnit unit)

Construct AmountOfSubstance scalar with a unit.

Parameters:

value - the double value, expressed in the given unit

unit - unit for the double value

AmountOfSubstance

public AmountOfSubstance(AmountOfSubstance value)

Construct AmountOfSubstance scalar.

Parameters:

value - Scalar from which to construct this instance

Method Details

instantiateRel

public final AmountOfSubstance instantiateRel(double value,
 AmountOfSubstanceUnit unit)

Description copied from class: DoubleScalarRel

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

Specified by:

instantiateRel in class DoubleScalarRel<AmountOfSubstanceUnit,AmountOfSubstance>

Parameters:

value - the double value

unit - the unit

Returns:

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

ofSI

public static final AmountOfSubstance ofSI(double value)

Construct AmountOfSubstance scalar based on an SI value.

Parameters:

value - the double value in SI units

Returns:

the new scalar with the SI value

interpolate

public static AmountOfSubstance interpolate(AmountOfSubstance zero,
 AmountOfSubstance one,
 double ratio)

Interpolate between two values. Note that the first value does not have to be smaller than the second.

Parameters:

zero - the value at a ratio of zero

one - the value at a ratio of one

ratio - the ratio between 0 and 1, inclusive

Returns:

a AmountOfSubstance at the given ratio between 0 and 1

max

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

Returns a AmountOfSubstance 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 - the textual representation to parse into a AmountOfSubstance

Returns:

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 AmountOfSubstance of(double value,
 String unitString)

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

Parameters:

value - the value to use

unitString - the textual representation of the unit

Returns:

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 Dimensionless divide(AmountOfSubstance v)

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

Parameters:

v - scalar

Returns:

scalar as a division of AmountOfSubstance and AmountOfSubstance

divide

public final Duration divide(CatalyticActivity v)

Calculate the division of AmountOfSubstance and CatalyticActivity, which results in a Duration scalar.

Parameters:

v - scalar

Returns:

scalar as a division of AmountOfSubstance and CatalyticActivity

divide

public final CatalyticActivity divide(Duration v)

Calculate the division of AmountOfSubstance and Duration, which results in a CatalyticActivity scalar.

Parameters:

v - scalar

Returns:

scalar as a division of AmountOfSubstance and Duration

reciprocal

public SIScalar reciprocal()

Description copied from class: DoubleScalarRel

Create the reciprocal of this scalar with the correct dimensions.

Overrides:

reciprocal in class DoubleScalarRel<AmountOfSubstanceUnit,AmountOfSubstance>

Returns:

a new scalar instance with correct SI dimensions

multiply

public static AmountOfSubstance multiply(DoubleScalarRel<?,?> scalar1,
 DoubleScalarRel<?,?> scalar2)

Multiply two scalars that result in a scalar of type AmountOfSubstance.

Parameters:

scalar1 - the first scalar

scalar2 - the second scalar

Returns:

the multiplication of both scalars as an instance of AmountOfSubstance

divide

public static AmountOfSubstance divide(DoubleScalarRel<?,?> scalar1,
 DoubleScalarRel<?,?> scalar2)

Divide two scalars that result in a scalar of type AmountOfSubstance.

Parameters:

scalar1 - the first scalar

scalar2 - the second scalar

Returns:

the division of scalar1 by scalar2 as an instance of AmountOfSubstance