org.djunits.value.vdouble.scalar.Mass

All Implemented Interfaces:: Serializable, Cloneable, Comparable<Mass>, Relative<MassUnit,Mass>, Value<MassUnit,Mass>

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

Easy access methods for the Mass 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 Mass

NaN

Constant with value NaN.

static final Mass

NEG_MAXVALUE

Constant with value -MAX_VALUE.

static final Mass

NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

static final Mass

ONE

Constant with value one.

static final Mass

POS_MAXVALUE

Constant with value MAX_VALUE.

static final Mass

POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

static final Mass

ZERO

Constant with value zero.

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

Constructors

Constructor

Description

Mass(double value, MassUnit unit)

Construct Mass scalar with a unit.

Mass(Mass value)

Construct Mass scalar.
Method Summary

Modifier and Type

Method

Description

static Mass

divide(DoubleScalarRel<?,?> scalar1, DoubleScalarRel<?,?> scalar2)

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

final Volume

divide(Density v)

Calculate the division of Mass and Density, which results in a Volume scalar.

final FlowMass

divide(Duration v)

Calculate the division of Mass and Duration, which results in a FlowMass scalar.

final Duration

divide(FlowMass v)

Calculate the division of Mass and FlowMass, which results in a Duration scalar.

final Dimensionless

divide(Mass v)

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

final Density

divide(Volume v)

Calculate the division of Mass and Volume, which results in a Density scalar.

final Mass

instantiateRel(double value, MassUnit unit)

Construct a new Relative Immutable DoubleScalar of the right type.

static Mass

interpolate(Mass zero, Mass one, double ratio)

Interpolate between two values.

static Mass

max(Mass r1, Mass r2)

Return the maximum value of two relative scalars.

static Mass

max(Mass r1, Mass r2, Mass... rn)

Return the maximum value of more than two relative scalars.

static Mass

min(Mass r1, Mass r2)

Return the minimum value of two relative scalars.

static Mass

min(Mass r1, Mass r2, Mass... rn)

Return the minimum value of more than two relative scalars.

static Mass

multiply(DoubleScalarRel<?,?> scalar1, DoubleScalarRel<?,?> scalar2)

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

static Mass

of(double value, String unitString)

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

static final Mass

ofSI(double value)

Construct Mass scalar based on an SI value.

SIScalar

reciprocal()

Create the reciprocal of this scalar with the correct dimensions.

final Force

times(Acceleration v)

Calculate the multiplication of Mass and Acceleration, which results in a Force scalar.

final FlowMass

times(Frequency v)

Calculate the multiplication of Mass and Frequency, which results in a FlowMass scalar.

final Momentum

times(Speed v)

Calculate the multiplication of Mass and Speed, which results in a Momentum scalar.

String

toStringSIPrefixed(int smallestPower, int biggestPower)

Format this DoubleScalar in SI unit using prefixes when possible and within the specified size range.

static Mass

valueOf(String text)

Returns a Mass 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, 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 Mass ZERO
  
  Constant with value zero.
- ONE
  
  public static final Mass ONE
  
  Constant with value one.
- NaN
  
  public static final Mass NaN
  
  Constant with value NaN.
- POSITIVE_INFINITY
  
  public static final Mass POSITIVE_INFINITY
  
  Constant with value POSITIVE_INFINITY.
- NEGATIVE_INFINITY
  
  public static final Mass NEGATIVE_INFINITY
  
  Constant with value NEGATIVE_INFINITY.
- POS_MAXVALUE
  
  public static final Mass POS_MAXVALUE
  
  Constant with value MAX_VALUE.
- NEG_MAXVALUE
  
  public static final Mass NEG_MAXVALUE
  
  Constant with value -MAX_VALUE.
Constructor Details
- Mass
  
  public Mass(double value, MassUnit unit)
  
  Construct Mass scalar with a unit.
  
  Parameters:
  
  value - the double value, expressed in the given unit
  
  unit - unit for the double value
- Mass
  
  public Mass(Mass value)
  
  Construct Mass scalar.
  
  Parameters:
  
  value - Scalar from which to construct this instance
Method Details
- instantiateRel
  
  public final Mass instantiateRel(double value, MassUnit 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<MassUnit,Mass>
  
  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 Mass ofSI(double value)
  
  Construct Mass 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 Mass interpolate(Mass zero, Mass 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 Mass at the given ratio between 0 and 1
- max
  
  public static Mass max(Mass r1, Mass 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 Mass max(Mass r1, Mass r2, Mass... 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 Mass min(Mass r1, Mass 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 Mass min(Mass r1, Mass r2, Mass... 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 Mass valueOf(String text)
  
  Returns a Mass 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 Mass
  
  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 Mass of(double value, String unitString)
  
  Returns a Mass 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
- toStringSIPrefixed
  
  public String toStringSIPrefixed(int smallestPower, int biggestPower)
  
  Description copied from class: DoubleScalar
  
  Format this DoubleScalar in SI unit using prefixes when possible and within the specified size range. If the value is too small or too large, e-notation and the plain SI unit are used.
  
  Overrides:
  
  toStringSIPrefixed in class DoubleScalar<MassUnit,Mass>
  
  Parameters:
  
  smallestPower - the smallest exponent value that will be written using an SI prefix
  
  biggestPower - the largest exponent value that will be written using an SI prefix
  
  Returns:
  
  formatted value of this DoubleScalar
- divide
  
  public final Dimensionless divide(Mass v)
  
  Calculate the division of Mass and Mass, which results in a Dimensionless scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a division of Mass and Mass
- divide
  
  public final Duration divide(FlowMass v)
  
  Calculate the division of Mass and FlowMass, which results in a Duration scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a division of Mass and FlowMass
- divide
  
  public final FlowMass divide(Duration v)
  
  Calculate the division of Mass and Duration, which results in a FlowMass scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a division of Mass and Duration
- times
  
  public final Force times(Acceleration v)
  
  Calculate the multiplication of Mass and Acceleration, which results in a Force scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a multiplication of Mass and Acceleration
- times
  
  public final FlowMass times(Frequency v)
  
  Calculate the multiplication of Mass and Frequency, which results in a FlowMass scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a multiplication of Mass and Frequency
- divide
  
  public final Volume divide(Density v)
  
  Calculate the division of Mass and Density, which results in a Volume scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a division of Mass and Density
- divide
  
  public final Density divide(Volume v)
  
  Calculate the division of Mass and Volume, which results in a Density scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a division of Mass and Volume
- times
  
  public final Momentum times(Speed v)
  
  Calculate the multiplication of Mass and Speed, which results in a Momentum scalar.
  
  Parameters:
  
  v - scalar
  
  Returns:
  
  scalar as a multiplication of Mass and Speed
- reciprocal
  
  public SIScalar reciprocal()
  
  Description copied from class: DoubleScalarRel
  
  Create the reciprocal of this scalar with the correct dimensions.
  
  Overrides:
  
  reciprocal in class DoubleScalarRel<MassUnit,Mass>
  
  Returns:
  
  a new scalar instance with correct SI dimensions
- multiply
  
  public static Mass multiply(DoubleScalarRel<?,?> scalar1, DoubleScalarRel<?,?> scalar2)
  
  Multiply two scalars that result in a scalar of type Mass.
  
  Parameters:
  
  scalar1 - the first scalar
  
  scalar2 - the second scalar
  
  Returns:
  
  the multiplication of both scalars as an instance of Mass
- divide
  
  public static Mass divide(DoubleScalarRel<?,?> scalar1, DoubleScalarRel<?,?> scalar2)
  
  Divide two scalars that result in a scalar of type Mass.
  
  Parameters:
  
  scalar1 - the first scalar
  
  scalar2 - the second scalar
  
  Returns:
  
  the division of scalar1 by scalar2 as an instance of Mass

Class Mass

Field Summary

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Number

Methods inherited from class java.lang.Object

Methods inherited from interface org.djunits.value.Value

Field Details

ZERO

ONE

NaN

POSITIVE_INFINITY

NEGATIVE_INFINITY

POS_MAXVALUE

NEG_MAXVALUE

Constructor Details

Mass

Mass

Method Details

instantiateRel

ofSI

interpolate

max

max

min

min

valueOf

of

toStringSIPrefixed

divide

divide

divide

times

times

divide

divide

times

reciprocal

multiply

divide