Package org.djunits.value.vfloat.scalar

Class FloatMomentum

    • Field Detail

      • ZERO

        public static final FloatMomentum ZERO
        Constant with value zero.

      • ONE

        public static final FloatMomentum ONE
        Constant with value one.

      • NaN

        public static final FloatMomentum NaN
        Constant with value NaN.

      • POSITIVE_INFINITY

        public static final FloatMomentum POSITIVE_INFINITY
        Constant with value POSITIVE_INFINITY.

      • NEGATIVE_INFINITY

        public static final FloatMomentum NEGATIVE_INFINITY
        Constant with value NEGATIVE_INFINITY.

      • POS_MAXVALUE

        public static final FloatMomentum POS_MAXVALUE
        Constant with value MAX_VALUE.

      • NEG_MAXVALUE

        public static final FloatMomentum NEG_MAXVALUE
        Constant with value -MAX_VALUE.

    • Constructor Detail

      • FloatMomentum

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

      • FloatMomentum

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

      • FloatMomentum

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

    • Method Detail

      • instantiateRel

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

      • interpolate

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

      • divide

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

      • divide

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

      • divide

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

      • divide

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

      • times

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

      • times

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