Class FloatFlowMass

    • Field Detail

      • ZERO

        public static final FloatFlowMass ZERO
        Constant with value zero.
      • ONE

        public static final FloatFlowMass ONE
        Constant with value one.
      • NaN

        public static final FloatFlowMass NaN
        Constant with value NaN.
      • POSITIVE_INFINITY

        public static final FloatFlowMass POSITIVE_INFINITY
        Constant with value POSITIVE_INFINITY.
      • NEGATIVE_INFINITY

        public static final FloatFlowMass NEGATIVE_INFINITY
        Constant with value NEGATIVE_INFINITY.
      • POS_MAXVALUE

        public static final FloatFlowMass POS_MAXVALUE
        Constant with value MAX_VALUE.
      • NEG_MAXVALUE

        public static final FloatFlowMass NEG_MAXVALUE
        Constant with value -MAX_VALUE.
    • Constructor Detail

      • FloatFlowMass

        public FloatFlowMass​(float value,
                             FlowMassUnit unit)
        Construct FloatFlowMass scalar.
        Parameters:
        value - float; the float value
        unit - unit for the float value
      • FloatFlowMass

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

        public FloatFlowMass​(double value,
                             FlowMassUnit unit)
        Construct FloatFlowMass scalar using a double value.
        Parameters:
        value - double; the double value
        unit - unit for the resulting float value
    • Method Detail

      • instantiateRel

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

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

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

        public final FloatMass divide​(FloatFrequency v)
        Calculate the division of FloatFlowMass and FloatFrequency, which results in a FloatMass scalar.
        Parameters:
        v - FloatFlowMass; scalar
        Returns:
        FloatMass; scalar as a division of FloatFlowMass and FloatFrequency
      • divide

        public final FloatFrequency divide​(FloatMass v)
        Calculate the division of FloatFlowMass and FloatMass, which results in a FloatFrequency scalar.
        Parameters:
        v - FloatFlowMass; scalar
        Returns:
        FloatFrequency; scalar as a division of FloatFlowMass and FloatMass
      • times

        public final FloatForce times​(FloatSpeed v)
        Calculate the multiplication of FloatFlowMass and FloatSpeed, which results in a FloatForce scalar.
        Parameters:
        v - FloatFlowMass; scalar
        Returns:
        FloatForce; scalar as a multiplication of FloatFlowMass and FloatSpeed
      • divide

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

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

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