Package org.djunits.value.vfloat.scalar

Class FloatDensity

    • Field Detail

      • ZERO

        public static final FloatDensity ZERO
        Constant with value zero.

      • ONE

        public static final FloatDensity ONE
        Constant with value one.

      • NaN

        public static final FloatDensity NaN
        Constant with value NaN.

      • POSITIVE_INFINITY

        public static final FloatDensity POSITIVE_INFINITY
        Constant with value POSITIVE_INFINITY.

      • NEGATIVE_INFINITY

        public static final FloatDensity NEGATIVE_INFINITY
        Constant with value NEGATIVE_INFINITY.

      • POS_MAXVALUE

        public static final FloatDensity POS_MAXVALUE
        Constant with value MAX_VALUE.

      • NEG_MAXVALUE

        public static final FloatDensity NEG_MAXVALUE
        Constant with value -MAX_VALUE.

    • Constructor Detail

      • FloatDensity

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

      • FloatDensity

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

      • FloatDensity

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

    • Method Detail

      • instantiateRel

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

      • interpolate

        public static FloatDensity interpolate​(FloatDensity zero,
                                       FloatDensity 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

      • max

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

      • times

        public final FloatMass times​(FloatVolume v)
        Calculate the multiplication of FloatDensity and FloatVolume, which results in a FloatMass scalar.
        Parameters:
        v - FloatDensity scalar
        Returns:
        FloatMass scalar as a multiplication of FloatDensity and FloatVolume

      • times

        public final FloatFlowMass times​(FloatFlowVolume v)
        Calculate the multiplication of FloatDensity and FloatFlowVolume, which results in a FloatFlowMass scalar.
        Parameters:
        v - FloatDensity scalar
        Returns:
        FloatFlowMass scalar as a multiplication of FloatDensity and FloatFlowVolume