Package org.djunits.value.vdouble.scalar

Class LuminousIntensity

    • Field Detail

      • POSITIVE_INFINITY

        public static final LuminousIntensity POSITIVE_INFINITY
        Constant with value POSITIVE_INFINITY.

      • NEGATIVE_INFINITY

        public static final LuminousIntensity NEGATIVE_INFINITY
        Constant with value NEGATIVE_INFINITY.

      • POS_MAXVALUE

        public static final LuminousIntensity POS_MAXVALUE
        Constant with value MAX_VALUE.

      • NEG_MAXVALUE

        public static final LuminousIntensity NEG_MAXVALUE
        Constant with value -MAX_VALUE.

    • Constructor Detail

      • LuminousIntensity

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

      • LuminousIntensity

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

    • Method Detail

      • instantiateRel

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

      • interpolate

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

      • max

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

      • max

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

      • min

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

      • min

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

      • valueOf

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

      • times

        public final LuminousFlux times​(SolidAngle v)
        Calculate the multiplication of LuminousIntensity and SolidAngle, which results in a LuminousFlux scalar.
        Parameters:
        v - LuminousIntensity scalar
        Returns:
        LuminousFlux scalar as a multiplication of LuminousIntensity and SolidAngle