Package org.djunits.value.vfloat.scalar

Class FloatAngle

    • Field Detail

      • ZERO

        public static final FloatAngle ZERO
        Constant with value zero.

      • ONE

        public static final FloatAngle ONE
        Constant with value one.

      • NaN

        public static final FloatAngle NaN
        Constant with value NaN.

      • POSITIVE_INFINITY

        public static final FloatAngle POSITIVE_INFINITY
        Constant with value POSITIVE_INFINITY.

      • NEGATIVE_INFINITY

        public static final FloatAngle NEGATIVE_INFINITY
        Constant with value NEGATIVE_INFINITY.

      • POS_MAXVALUE

        public static final FloatAngle POS_MAXVALUE
        Constant with value MAX_VALUE.

      • NEG_MAXVALUE

        public static final FloatAngle NEG_MAXVALUE
        Constant with value -MAX_VALUE.

    • Constructor Detail

      • FloatAngle

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

      • FloatAngle

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

      • FloatAngle

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

    • Method Detail

      • instantiateRel

        public final FloatAngle instantiateRel​(float value,
                                       AngleUnit 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 - RU; the unit
        Returns:
        R a new relative instance of the FloatScalar of the right type

      • instantiateSI

        public static final FloatAngle instantiateSI​(float value)
        Construct FloatAngle scalar.
        Parameters:
        value - float; the float value in SI units
        Returns:
        FloatAngle; the new scalar with the SI value

      • instantiateAbs

        public final FloatDirection instantiateAbs​(float value,
                                           DirectionUnit unit)
        Construct a new Absolute Immutable FloatScalar of the right type. Each extending class must implement this method.
        Parameters:
        value - float; the float value
        unit - AU; the absolute unit
        Returns:
        A a new absolute instance of the FloatScalar of the right type

      • interpolate

        public static FloatAngle interpolate​(FloatAngle zero,
                                     FloatAngle one,
                                     float ratio)
        Interpolate between two values.
        Parameters:
        zero - FloatAngle; the low value
        one - FloatAngle; the high value
        ratio - double; the ratio between 0 and 1, inclusive
        Returns:
        FloatAngle; a Scalar at the ratio between

      • max

        public static FloatAngle max​(FloatAngle r1,
                             FloatAngle r2)
        Return the maximum value of two relative scalars.
        Parameters:
        r1 - FloatAngle; the first scalar
        r2 - FloatAngle; the second scalar
        Returns:
        FloatAngle; the maximum value of two relative scalars

      • max

        public static FloatAngle max​(FloatAngle r1,
                             FloatAngle r2,
                             FloatAngle... rn)
        Return the maximum value of more than two relative scalars.
        Parameters:
        r1 - FloatAngle; the first scalar
        r2 - FloatAngle; the second scalar
        rn - FloatAngle...; the other scalars
        Returns:
        FloatAngle; the maximum value of more than two relative scalars

      • min

        public static FloatAngle min​(FloatAngle r1,
                             FloatAngle r2)
        Return the minimum value of two relative scalars.
        Parameters:
        r1 - FloatAngle; the first scalar
        r2 - FloatAngle; the second scalar
        Returns:
        FloatAngle; the minimum value of two relative scalars

      • min

        public static FloatAngle min​(FloatAngle r1,
                             FloatAngle r2,
                             FloatAngle... rn)
        Return the minimum value of more than two relative scalars.
        Parameters:
        r1 - FloatAngle; the first scalar
        r2 - FloatAngle; the second scalar
        rn - FloatAngle...; the other scalars
        Returns:
        FloatAngle; the minimum value of more than two relative scalars

      • valueOf

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

      • times

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

      • divide

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

      • divide

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