Package org.djunits.value.vdouble.scalar

Class Temperature

    • Field Detail

      • ZERO

        public static final Temperature ZERO
        Constant with value zero.

      • ONE

        public static final Temperature ONE
        Constant with value one.

      • NaN

        public static final Temperature NaN
        Constant with value NaN.

      • POSITIVE_INFINITY

        public static final Temperature POSITIVE_INFINITY
        Constant with value POSITIVE_INFINITY.

      • NEGATIVE_INFINITY

        public static final Temperature NEGATIVE_INFINITY
        Constant with value NEGATIVE_INFINITY.

      • POS_MAXVALUE

        public static final Temperature POS_MAXVALUE
        Constant with value MAX_VALUE.

      • NEG_MAXVALUE

        public static final Temperature NEG_MAXVALUE
        Constant with value -MAX_VALUE.

    • Constructor Detail

      • Temperature

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

      • Temperature

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

    • Method Detail

      • instantiateRel

        public final Temperature instantiateRel​(double value,
                                        TemperatureUnit 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 - RU; the unit
        Returns:
        R a new relative instance of the DoubleScalar of the right type

      • instantiateAbs

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

      • instantiateSI

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

      • interpolate

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

      • max

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

      • max

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

      • min

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

      • min

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

      • valueOf

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