Package org.djunits.value.vdouble.scalar

Class AmountOfSubstance

    • Field Detail

      • 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 Detail

      • AmountOfSubstance

        public AmountOfSubstance​(double value,
                         AmountOfSubstanceUnit unit)
        Construct AmountOfSubstance scalar.
        Parameters:
        value - double; the double value
        unit - AmountOfSubstanceUnit; unit for the double value

      • AmountOfSubstance

        public AmountOfSubstance​(AmountOfSubstance value)
        Construct AmountOfSubstance scalar.
        Parameters:
        value - AmountOfSubstance; Scalar from which to construct this instance

    • Method Detail

      • instantiateRel

        public final AmountOfSubstance instantiateRel​(double value,
                                              AmountOfSubstanceUnit unit)
        Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.
        Parameters:
        value - double; the double value
        unit - U; the unit
        Returns:
        R a new relative instance of the DoubleScalar of the right type

      • instantiateSI

        public static final AmountOfSubstance instantiateSI​(double value)
        Construct AmountOfSubstance scalar.
        Parameters:
        value - double; the double value in SI units
        Returns:
        AmountOfSubstance; the new scalar with the SI value

      • interpolate

        public static AmountOfSubstance interpolate​(AmountOfSubstance zero,
                                            AmountOfSubstance one,
                                            double ratio)
        Interpolate between two values.
        Parameters:
        zero - AmountOfSubstance; the low value
        one - AmountOfSubstance; the high value
        ratio - double; the ratio between 0 and 1, inclusive
        Returns:
        AmountOfSubstance; a Scalar at the ratio between

      • max

        public static AmountOfSubstance max​(AmountOfSubstance r1,
                                    AmountOfSubstance r2)
        Return the maximum value of two relative scalars.
        Parameters:
        r1 - AmountOfSubstance; the first scalar
        r2 - AmountOfSubstance; the second scalar
        Returns:
        AmountOfSubstance; 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 - AmountOfSubstance; the first scalar
        r2 - AmountOfSubstance; the second scalar
        rn - AmountOfSubstance...; the other scalars
        Returns:
        AmountOfSubstance; 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 - AmountOfSubstance; the first scalar
        r2 - AmountOfSubstance; the second scalar
        Returns:
        AmountOfSubstance; 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 - AmountOfSubstance; the first scalar
        r2 - AmountOfSubstance; the second scalar
        rn - AmountOfSubstance...; the other scalars
        Returns:
        AmountOfSubstance; 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 the official 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 AmountOfSubstance
        Returns:
        AmountOfSubstance; 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.
        Parameters:
        value - double; the value to use
        unitString - String; the textual representation of the unit
        Returns:
        AmountOfSubstance; 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 - AmountOfSubstance scalar
        Returns:
        Dimensionless 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 - AmountOfSubstance scalar
        Returns:
        Duration 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 - AmountOfSubstance scalar
        Returns:
        CatalyticActivity scalar as a division of AmountOfSubstance and Duration