Package org.djunits.value.vdouble.scalar

Class EquivalentDose

    • Field Detail

      • ZERO

        public static final EquivalentDose ZERO
        Constant with value zero.

      • ONE

        public static final EquivalentDose ONE
        Constant with value one.

      • NaN

        public static final EquivalentDose NaN
        Constant with value NaN.

      • POSITIVE_INFINITY

        public static final EquivalentDose POSITIVE_INFINITY
        Constant with value POSITIVE_INFINITY.

      • NEGATIVE_INFINITY

        public static final EquivalentDose NEGATIVE_INFINITY
        Constant with value NEGATIVE_INFINITY.

      • POS_MAXVALUE

        public static final EquivalentDose POS_MAXVALUE
        Constant with value MAX_VALUE.

      • NEG_MAXVALUE

        public static final EquivalentDose NEG_MAXVALUE
        Constant with value -MAX_VALUE.

    • Constructor Detail

      • EquivalentDose

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

      • EquivalentDose

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

    • Method Detail

      • instantiateRel

        public final EquivalentDose instantiateRel​(double value,
                                           EquivalentDoseUnit 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 EquivalentDose instantiateSI​(double value)
        Construct EquivalentDose scalar.
        Parameters:
        value - double; the double value in SI units
        Returns:
        EquivalentDose; the new scalar with the SI value

      • interpolate

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

      • max

        public static EquivalentDose max​(EquivalentDose r1,
                                 EquivalentDose r2)
        Return the maximum value of two relative scalars.
        Parameters:
        r1 - EquivalentDose; the first scalar
        r2 - EquivalentDose; the second scalar
        Returns:
        EquivalentDose; the maximum value of two relative scalars

      • max

        public static EquivalentDose max​(EquivalentDose r1,
                                 EquivalentDose r2,
                                 EquivalentDose... rn)
        Return the maximum value of more than two relative scalars.
        Parameters:
        r1 - EquivalentDose; the first scalar
        r2 - EquivalentDose; the second scalar
        rn - EquivalentDose...; the other scalars
        Returns:
        EquivalentDose; the maximum value of more than two relative scalars

      • min

        public static EquivalentDose min​(EquivalentDose r1,
                                 EquivalentDose r2)
        Return the minimum value of two relative scalars.
        Parameters:
        r1 - EquivalentDose; the first scalar
        r2 - EquivalentDose; the second scalar
        Returns:
        EquivalentDose; the minimum value of two relative scalars

      • min

        public static EquivalentDose min​(EquivalentDose r1,
                                 EquivalentDose r2,
                                 EquivalentDose... rn)
        Return the minimum value of more than two relative scalars.
        Parameters:
        r1 - EquivalentDose; the first scalar
        r2 - EquivalentDose; the second scalar
        rn - EquivalentDose...; the other scalars
        Returns:
        EquivalentDose; the minimum value of more than two relative scalars

      • valueOf

        public static EquivalentDose valueOf​(String text)
        Returns a EquivalentDose 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 EquivalentDose
        Returns:
        EquivalentDose; 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 EquivalentDose of​(double value,
                                String unitString)
        Returns a EquivalentDose 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:
        EquivalentDose; 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​(EquivalentDose v)
        Calculate the division of EquivalentDose and EquivalentDose, which results in a Dimensionless scalar.
        Parameters:
        v - EquivalentDose; scalar
        Returns:
        Dimensionless; scalar as a division of EquivalentDose and EquivalentDose