Package org.djunits.value.vfloat.scalar

Class FloatAbsorbedDose

    • Field Detail

      • POSITIVE_INFINITY

        public static final FloatAbsorbedDose POSITIVE_INFINITY
        Constant with value POSITIVE_INFINITY.

      • NEGATIVE_INFINITY

        public static final FloatAbsorbedDose NEGATIVE_INFINITY
        Constant with value NEGATIVE_INFINITY.

      • POS_MAXVALUE

        public static final FloatAbsorbedDose POS_MAXVALUE
        Constant with value MAX_VALUE.

      • NEG_MAXVALUE

        public static final FloatAbsorbedDose NEG_MAXVALUE
        Constant with value -MAX_VALUE.

    • Constructor Detail

      • FloatAbsorbedDose

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

      • FloatAbsorbedDose

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

      • FloatAbsorbedDose

        public FloatAbsorbedDose​(double value,
                         AbsorbedDoseUnit unit)
        Construct FloatAbsorbedDose scalar using a double value.
        Parameters:
        value - double; the double value
        unit - unit for the resulting float value

    • Method Detail

      • instantiateRel

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

      • instantiateSI

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

      • interpolate

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

      • valueOf

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