Class Jerk

    • Constructor Detail

      • Jerk

        public Jerk​(double value,
                    JerkUnit unit)
        Construct Jerk scalar.
        Parameters:
        value - double; the double value
        unit - JerkUnit; unit for the double value
      • Jerk

        public Jerk​(Jerk value)
        Construct Jerk scalar.
        Parameters:
        value - Jerk; Scalar from which to construct this instance
    • Method Detail

      • instantiateRel

        public final Jerk instantiateRel​(double value,
                                         JerkUnit unit)
      • instantiateSI

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

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

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

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

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

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

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

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

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