Class FloatMass

    • Field Detail

      • ZERO

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

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

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

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

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

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

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

      • FloatMass

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

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

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

      • instantiateRel

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

        public static FloatMass interpolate​(FloatMass zero,
                                            FloatMass 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 FloatMass max​(FloatMass r1,
                                    FloatMass 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 FloatMass max​(FloatMass r1,
                                    FloatMass r2,
                                    FloatMass... 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 FloatMass min​(FloatMass r1,
                                    FloatMass 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 FloatMass min​(FloatMass r1,
                                    FloatMass r2,
                                    FloatMass... 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 FloatMass valueOf​(String text)
        Returns a FloatMass 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 FloatMass
        Returns:
        FloatMass; 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 FloatMass of​(float value,
                                   String unitString)
        Returns a FloatMass 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:
        FloatMass; 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
      • toStringSIPrefixed

        public String toStringSIPrefixed​(int smallestPower,
                                         int biggestPower)
        Format this AbstractDoubleScalar in SI unit using prefixes when possible and within the specified size range. If the value is too small or too large, e-notation and the plain SI unit are used.
        Overrides:
        toStringSIPrefixed in class AbstractFloatScalar<MassUnit,​FloatMass>
        Parameters:
        smallestPower - int; the smallest exponent value that will be written using an SI prefix
        biggestPower - int; the largest exponent value that will be written using an SI prefix
        Returns:
        String; formatted value of this AbstractDoubleScalar
      • divide

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

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

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

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

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

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

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

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