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="2025-09-06T15:16:28.380798Z") public class FloatAmountOfSubstance extends FloatScalarRel<AmountOfSubstanceUnit,FloatAmountOfSubstance>
Easy access methods for the FloatAmountOfSubstance FloatScalar, 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:

  • Field Details

  • Constructor Details

    • FloatAmountOfSubstance

      public FloatAmountOfSubstance(float value, AmountOfSubstanceUnit unit)
      Construct FloatAmountOfSubstance scalar with a unit.
      Parameters:
      value - the float value, expressed in the given unit
      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 with a unit using a double value.
      Parameters:
      value - the double value, expressed in the given unit
      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 - the float value
      unit - the unit
      Returns:
      R a new relative instance of the FloatScalar of the right type

    • ofSI

      public static final FloatAmountOfSubstance ofSI(float value)
      Construct FloatAmountOfSubstance scalar based on an SI value.
      Parameters:
      value - 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. 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 FloatAmountOfSubstance at the given ratio between 0 and 1

    • 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 - the textual representation to parse into a FloatAmountOfSubstance
      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 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 - 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 FloatDimensionless divide(FloatAmountOfSubstance v)
      Calculate the division of FloatAmountOfSubstance and FloatAmountOfSubstance, which results in a FloatDimensionless scalar.
      Parameters:
      v - scalar
      Returns:
      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 - scalar
      Returns:
      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 - scalar
      Returns:
      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.
      Overrides:
      reciprocal in class FloatScalarRel<AmountOfSubstanceUnit,FloatAmountOfSubstance>
      Returns:
      a new scalar instance with correct SI dimensions

    • multiply

      public static FloatAmountOfSubstance multiply(FloatScalarRel<?,?> scalar1, FloatScalarRel<?,?> scalar2)
      Multiply two scalars that result in a scalar of type FloatAmountOfSubstance.
      Parameters:
      scalar1 - the first scalar
      scalar2 - the second scalar
      Returns:
      the multiplication of both scalars as an instance of FloatAmountOfSubstance

    • divide

      public static FloatAmountOfSubstance divide(FloatScalarRel<?,?> scalar1, FloatScalarRel<?,?> scalar2)
      Divide two scalars that result in a scalar of type FloatAmountOfSubstance.
      Parameters:
      scalar1 - the first scalar
      scalar2 - the second scalar
      Returns:
      the division of scalar1 by scalar2 as an instance of FloatAmountOfSubstance