Package org.djunits.value.vdouble.scalar

Class Frequency

    • Field Detail

      • ZERO

        public static final Frequency ZERO
        Constant with value zero.

      • ONE

        public static final Frequency ONE
        Constant with value one.

      • NaN

        public static final Frequency NaN
        Constant with value NaN.

      • POSITIVE_INFINITY

        public static final Frequency POSITIVE_INFINITY
        Constant with value POSITIVE_INFINITY.

      • NEGATIVE_INFINITY

        public static final Frequency NEGATIVE_INFINITY
        Constant with value NEGATIVE_INFINITY.

      • POS_MAXVALUE

        public static final Frequency POS_MAXVALUE
        Constant with value MAX_VALUE.

      • NEG_MAXVALUE

        public static final Frequency NEG_MAXVALUE
        Constant with value -MAX_VALUE.

    • Constructor Detail

      • Frequency

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

      • Frequency

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

    • Method Detail

      • instantiateRel

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

      • interpolate

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

      • max

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

      • max

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

      • min

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

      • min

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

      • valueOf

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

      • times

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

      • times

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

      • times

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

      • times

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

      • times

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

      • times

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