Package org.djunits.value.vfloat.scalar

Class FloatVolume

    • Field Detail

      • ZERO

        public static final FloatVolume ZERO
        Constant with value zero.

      • ONE

        public static final FloatVolume ONE
        Constant with value one.

      • NaN

        public static final FloatVolume NaN
        Constant with value NaN.

      • POSITIVE_INFINITY

        public static final FloatVolume POSITIVE_INFINITY
        Constant with value POSITIVE_INFINITY.

      • NEGATIVE_INFINITY

        public static final FloatVolume NEGATIVE_INFINITY
        Constant with value NEGATIVE_INFINITY.

      • POS_MAXVALUE

        public static final FloatVolume POS_MAXVALUE
        Constant with value MAX_VALUE.

      • NEG_MAXVALUE

        public static final FloatVolume NEG_MAXVALUE
        Constant with value -MAX_VALUE.

    • Constructor Detail

      • FloatVolume

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

      • FloatVolume

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

      • FloatVolume

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

    • Method Detail

      • instantiateRel

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

      • interpolate

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

      • times

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

      • times

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

      • divide

        public final FloatArea divide​(FloatLength v)
        Calculate the division of FloatVolume and FloatLength, which results in a FloatArea scalar.
        Parameters:
        v - FloatVolume; scalar
        Returns:
        FloatArea; scalar as a division of FloatVolume and FloatLength

      • divide

        public final FloatLength divide​(FloatArea v)
        Calculate the division of FloatVolume and FloatArea, which results in a FloatLength scalar.
        Parameters:
        v - FloatVolume; scalar
        Returns:
        FloatLength; scalar as a division of FloatVolume and FloatArea

      • times

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

      • divide

        public final FloatFlowVolume divide​(FloatDuration v)
        Calculate the division of FloatVolume and FloatDuration, which results in a FloatFlowVolume scalar.
        Parameters:
        v - FloatVolume; scalar
        Returns:
        FloatFlowVolume; scalar as a division of FloatVolume and FloatDuration

      • divide

        public final FloatDuration divide​(FloatFlowVolume v)
        Calculate the division of FloatVolume and FloatFlowVolume, which results in a FloatDuration scalar.
        Parameters:
        v - FloatVolume; scalar
        Returns:
        FloatDuration; scalar as a division of FloatVolume and FloatFlowVolume