Package org.djunits.value.vfloat.scalar

Class FloatIlluminance

java.lang.Object
java.lang.Number
org.djunits.value.base.Scalar<U,S>
org.djunits.value.vfloat.scalar.base.FloatScalar<U,R>
org.djunits.value.vfloat.scalar.base.FloatScalarRel<IlluminanceUnit,FloatIlluminance>
org.djunits.value.vfloat.scalar.FloatIlluminance
All Implemented Interfaces:
Serializable, Cloneable, Comparable<FloatIlluminance>, Relative<IlluminanceUnit,FloatIlluminance>, Value<IlluminanceUnit,FloatIlluminance>
@Generated(value="org.djunits.generator.GenerateDJUNIT", date="2025-09-06T15:16:28.380798Z") public class FloatIlluminance extends FloatScalarRel<IlluminanceUnit,FloatIlluminance>
Easy access methods for the FloatIlluminance FloatScalar, which is relative by definition.

Copyright (c) 2013-2025 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

Author:
Alexander Verbraeck, Peter Knoppers
See Also:

  • Field Details

    • ZERO

      public static final FloatIlluminance ZERO
      Constant with value zero.

    • ONE

      public static final FloatIlluminance ONE
      Constant with value one.

    • NaN

      public static final FloatIlluminance NaN
      Constant with value NaN.

    • POSITIVE_INFINITY

      public static final FloatIlluminance POSITIVE_INFINITY
      Constant with value POSITIVE_INFINITY.

    • NEGATIVE_INFINITY

      public static final FloatIlluminance NEGATIVE_INFINITY
      Constant with value NEGATIVE_INFINITY.

    • POS_MAXVALUE

      public static final FloatIlluminance POS_MAXVALUE
      Constant with value MAX_VALUE.

    • NEG_MAXVALUE

      public static final FloatIlluminance NEG_MAXVALUE
      Constant with value -MAX_VALUE.

  • Constructor Details

    • FloatIlluminance

      public FloatIlluminance(float value, IlluminanceUnit unit)
      Construct FloatIlluminance scalar with a unit.
      Parameters:
      value - the float value, expressed in the given unit
      unit - unit for the float value

    • FloatIlluminance

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

    • FloatIlluminance

      public FloatIlluminance(double value, IlluminanceUnit unit)
      Construct FloatIlluminance scalar with a unit using a double value.
      Parameters:
      value - the double value, expressed in the given unit
      unit - unit for the resulting float value

  • Method Details

    • instantiateRel

      public final FloatIlluminance instantiateRel(float value, IlluminanceUnit unit)
      Description copied from class: FloatScalarRel
      Construct a new Relative Immutable FloatScalar of the right type. Each extending class must implement this method.
      Specified by:
      instantiateRel in class FloatScalarRel<IlluminanceUnit,FloatIlluminance>
      Parameters:
      value - the float value
      unit - the unit
      Returns:
      R a new relative instance of the FloatScalar of the right type

    • ofSI

      public static final FloatIlluminance ofSI(float value)
      Construct FloatIlluminance scalar based on an SI value.
      Parameters:
      value - the float value in SI units
      Returns:
      the new scalar with the SI value

    • interpolate

      public static FloatIlluminance interpolate(FloatIlluminance zero, FloatIlluminance one, float ratio)
      Interpolate between two values. Note that the first value does not have to be smaller than the second.
      Parameters:
      zero - the value at a ratio of zero
      one - the value at a ratio of one
      ratio - the ratio between 0 and 1, inclusive
      Returns:
      a FloatIlluminance at the given ratio between 0 and 1

    • max

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

    • max

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

    • min

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

    • min

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

    • valueOf

      public static FloatIlluminance valueOf(String text)
      Returns a FloatIlluminance 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 a localized or English abbreviation of the unit. Spaces are allowed, but not required, between the value and the unit.
      Parameters:
      text - the textual representation to parse into a FloatIlluminance
      Returns:
      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 FloatIlluminance of(float value, String unitString)
      Returns a FloatIlluminance based on a value and the textual representation of the unit, which can be localized.
      Parameters:
      value - the value to use
      unitString - the textual representation of the unit
      Returns:
      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 FloatDimensionless divide(FloatIlluminance v)
      Calculate the division of FloatIlluminance and FloatIlluminance, which results in a FloatDimensionless scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a division of FloatIlluminance and FloatIlluminance

    • times

      public final FloatLuminousFlux times(FloatArea v)
      Calculate the multiplication of FloatIlluminance and FloatArea, which results in a FloatLuminousFlux scalar.
      Parameters:
      v - scalar
      Returns:
      scalar as a multiplication of FloatIlluminance and FloatArea

    • reciprocal

      public FloatSIScalar reciprocal()
      Description copied from class: FloatScalarRel
      Create the reciprocal of this scalar with the correct dimensions.
      Overrides:
      reciprocal in class FloatScalarRel<IlluminanceUnit,FloatIlluminance>
      Returns:
      a new scalar instance with correct SI dimensions

    • multiply

      public static FloatIlluminance multiply(FloatScalarRel<?,?> scalar1, FloatScalarRel<?,?> scalar2)
      Multiply two scalars that result in a scalar of type FloatIlluminance.
      Parameters:
      scalar1 - the first scalar
      scalar2 - the second scalar
      Returns:
      the multiplication of both scalars as an instance of FloatIlluminance

    • divide

      public static FloatIlluminance divide(FloatScalarRel<?,?> scalar1, FloatScalarRel<?,?> scalar2)
      Divide two scalars that result in a scalar of type FloatIlluminance.
      Parameters:
      scalar1 - the first scalar
      scalar2 - the second scalar
      Returns:
      the division of scalar1 by scalar2 as an instance of FloatIlluminance