Package org.djunits.value.vdouble.scalar

Class Speed

    • Field Detail

      • ZERO

        public static final Speed ZERO
        Constant with value zero.

      • ONE

        public static final Speed ONE
        Constant with value one.

      • NaN

        public static final Speed NaN
        Constant with value NaN.

      • POSITIVE_INFINITY

        public static final Speed POSITIVE_INFINITY
        Constant with value POSITIVE_INFINITY.

      • NEGATIVE_INFINITY

        public static final Speed NEGATIVE_INFINITY
        Constant with value NEGATIVE_INFINITY.

      • POS_MAXVALUE

        public static final Speed POS_MAXVALUE
        Constant with value MAX_VALUE.

      • NEG_MAXVALUE

        public static final Speed NEG_MAXVALUE
        Constant with value -MAX_VALUE.

    • Constructor Detail

      • Speed

        public Speed​(double value,
             SpeedUnit unit)
        Construct Speed scalar.
        Parameters:
        value - double; the double value
        unit - SpeedUnit; unit for the double value

      • Speed

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

    • Method Detail

      • instantiateRel

        public final Speed instantiateRel​(double value,
                                  SpeedUnit unit)
        Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.
        Parameters:
        value - double; the double value
        unit - U; the unit
        Returns:
        R a new relative instance of the DoubleScalar of the right type

      • instantiateSI

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

      • interpolate

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

      • max

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

      • max

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

      • min

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

      • min

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

      • valueOf

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

      • times

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

      • times

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

      • times

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

      • divide

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

      • divide

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

      • times

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

      • times

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

      • divide

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

      • divide

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

      • times

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

      • times

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

      • times

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