Class FloatForce

    • Field Detail

      • ZERO

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

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

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

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

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

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

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

      • FloatForce

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

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

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

      • instantiateRel

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

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

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

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

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

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

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

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

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

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