Package org.djunits.value.vfloat.scalar

Class FloatTorque

    • Field Detail

      • ZERO

        public static final FloatTorque ZERO
        Constant with value zero.

      • ONE

        public static final FloatTorque ONE
        Constant with value one.

      • NaN

        public static final FloatTorque NaN
        Constant with value NaN.

      • POSITIVE_INFINITY

        public static final FloatTorque POSITIVE_INFINITY
        Constant with value POSITIVE_INFINITY.

      • NEGATIVE_INFINITY

        public static final FloatTorque NEGATIVE_INFINITY
        Constant with value NEGATIVE_INFINITY.

      • POS_MAXVALUE

        public static final FloatTorque POS_MAXVALUE
        Constant with value MAX_VALUE.

      • NEG_MAXVALUE

        public static final FloatTorque NEG_MAXVALUE
        Constant with value -MAX_VALUE.

    • Constructor Detail

      • FloatTorque

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

      • FloatTorque

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

      • FloatTorque

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

    • Method Detail

      • instantiateRel

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

      • interpolate

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

      • divide

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

      • divide

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

      • times

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

      • divide

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

      • divide

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

      • times

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

      • divide

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

      • divide

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