Package org.djunits.value.vdouble.scalar

Class LuminousFlux

    • Field Detail

      • ZERO

        public static final LuminousFlux ZERO
        Constant with value zero.

      • ONE

        public static final LuminousFlux ONE
        Constant with value one.

      • NaN

        public static final LuminousFlux NaN
        Constant with value NaN.

      • POSITIVE_INFINITY

        public static final LuminousFlux POSITIVE_INFINITY
        Constant with value POSITIVE_INFINITY.

      • NEGATIVE_INFINITY

        public static final LuminousFlux NEGATIVE_INFINITY
        Constant with value NEGATIVE_INFINITY.

      • POS_MAXVALUE

        public static final LuminousFlux POS_MAXVALUE
        Constant with value MAX_VALUE.

      • NEG_MAXVALUE

        public static final LuminousFlux NEG_MAXVALUE
        Constant with value -MAX_VALUE.

    • Constructor Detail

      • LuminousFlux

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

      • LuminousFlux

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

    • Method Detail

      • instantiateRel

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

      • interpolate

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

      • max

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

      • max

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

      • min

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

      • min

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

      • valueOf

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

      • divide

        public final Illuminance divide​(Area v)
        Calculate the division of LuminousFlux and Area, which results in a Illuminance scalar.
        Parameters:
        v - LuminousFlux scalar
        Returns:
        Illuminance scalar as a division of LuminousFlux and Area

      • divide

        public final Area divide​(Illuminance v)
        Calculate the division of LuminousFlux and Illuminance, which results in a Area scalar.
        Parameters:
        v - LuminousFlux scalar
        Returns:
        Area scalar as a division of LuminousFlux and Illuminance

      • divide

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

      • divide

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