Package org.djunits.value.vdouble.scalar

Class AbsorbedDose

    • Field Detail

      • ZERO

        public static final AbsorbedDose ZERO
        Constant with value zero.

      • ONE

        public static final AbsorbedDose ONE
        Constant with value one.

      • NaN

        public static final AbsorbedDose NaN
        Constant with value NaN.

      • POSITIVE_INFINITY

        public static final AbsorbedDose POSITIVE_INFINITY
        Constant with value POSITIVE_INFINITY.

      • NEGATIVE_INFINITY

        public static final AbsorbedDose NEGATIVE_INFINITY
        Constant with value NEGATIVE_INFINITY.

      • POS_MAXVALUE

        public static final AbsorbedDose POS_MAXVALUE
        Constant with value MAX_VALUE.

      • NEG_MAXVALUE

        public static final AbsorbedDose NEG_MAXVALUE
        Constant with value -MAX_VALUE.

    • Constructor Detail

      • AbsorbedDose

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

      • AbsorbedDose

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

    • Method Detail

      • instantiateRel

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

      • interpolate

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

      • max

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

      • max

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

      • min

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

      • min

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

      • valueOf

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