Package org.djunits.value.vfloat.scalar

Class FloatLuminousFlux

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<LuminousFluxUnit,FloatLuminousFlux>

org.djunits.value.vfloat.scalar.FloatLuminousFlux

All Implemented Interfaces:

Serializable, Cloneable, Comparable<FloatLuminousFlux>, Relative<LuminousFluxUnit,FloatLuminousFlux>, Value<LuminousFluxUnit,FloatLuminousFlux>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-07-23T14:06:38.224104100Z")
public class FloatLuminousFlux
extends FloatScalarRel<LuminousFluxUnit,FloatLuminousFlux>

Easy access methods for the FloatLuminousFlux FloatScalar, which is relative by definition.

Copyright (c) 2013-2024 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:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final FloatLuminousFlux	NaN	Constant with value NaN.
static final FloatLuminousFlux	NEG_MAXVALUE	Constant with value -MAX_VALUE.
static final FloatLuminousFlux	NEGATIVE_INFINITY	Constant with value NEGATIVE_INFINITY.
static final FloatLuminousFlux	ONE	Constant with value one.
static final FloatLuminousFlux	POS_MAXVALUE	Constant with value MAX_VALUE.
static final FloatLuminousFlux	POSITIVE_INFINITY	Constant with value POSITIVE_INFINITY.
static final FloatLuminousFlux	ZERO	Constant with value zero.

Fields inherited from class org.djunits.value.vfloat.scalar.base.FloatScalar

si

Constructor Summary

Constructors

Constructor	Description
FloatLuminousFlux(double value, LuminousFluxUnit unit)	Construct FloatLuminousFlux scalar using a double value.
FloatLuminousFlux(float value, LuminousFluxUnit unit)	Construct FloatLuminousFlux scalar.
FloatLuminousFlux(FloatLuminousFlux value)	Construct FloatLuminousFlux scalar.

Method Summary

Modifier and Type	Method	Description
final FloatIlluminance	divide(FloatArea v)	Calculate the division of FloatLuminousFlux and FloatArea, which results in a FloatIlluminance scalar.
final FloatArea	divide(FloatIlluminance v)	Calculate the division of FloatLuminousFlux and FloatIlluminance, which results in a FloatArea scalar.
final FloatDimensionless	divide(FloatLuminousFlux v)	Calculate the division of FloatLuminousFlux and FloatLuminousFlux, which results in a FloatDimensionless scalar.
final FloatSolidAngle	divide(FloatLuminousIntensity v)	Calculate the division of FloatLuminousFlux and FloatLuminousIntensity, which results in a FloatSolidAngle scalar.
final FloatLuminousIntensity	divide(FloatSolidAngle v)	Calculate the division of FloatLuminousFlux and FloatSolidAngle, which results in a FloatLuminousIntensity scalar.
final FloatLuminousFlux	instantiateRel(float value, LuminousFluxUnit unit)	Construct a new Relative Immutable FloatScalar of the right type.
static final FloatLuminousFlux	instantiateSI(float value)	Construct FloatLuminousFlux scalar.
static FloatLuminousFlux	interpolate(FloatLuminousFlux zero, FloatLuminousFlux one, float ratio)	Interpolate between two values.
static FloatLuminousFlux	max(FloatLuminousFlux r1, FloatLuminousFlux r2)	Return the maximum value of two relative scalars.
static FloatLuminousFlux	max(FloatLuminousFlux r1, FloatLuminousFlux r2, FloatLuminousFlux... rn)	Return the maximum value of more than two relative scalars.
static FloatLuminousFlux	min(FloatLuminousFlux r1, FloatLuminousFlux r2)	Return the minimum value of two relative scalars.
static FloatLuminousFlux	min(FloatLuminousFlux r1, FloatLuminousFlux r2, FloatLuminousFlux... rn)	Return the minimum value of more than two relative scalars.
static FloatLuminousFlux	of(float value, String unitString)	Returns a FloatLuminousFlux based on a value and the textual representation of the unit, which can be localized.
FloatSIScalar	reciprocal()	Create the reciprocal of this scalar with the correct dimensions.
static FloatLuminousFlux	valueOf(String text)	Returns a FloatLuminousFlux representation of a textual representation of a value with a unit.

Methods inherited from class org.djunits.value.vfloat.scalar.base.FloatScalarRel

abs, ceil, divide, divide, divide, floor, minus, neg, plus, rint, times, times, times

Methods inherited from class org.djunits.value.vfloat.scalar.base.FloatScalar

compareTo, divide, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, instantiate, instantiateAnonymous, instantiateSI, interpolate, interpolate, intValue, le, le0, longValue, lt, lt0, max, max, min, min, minus, minus, minus, multiply, ne, ne0, plus, plus, plus, toDisplayString, toDisplayString, toString, toString, toString, toString, toStringSIPrefixed, toStringSIPrefixed, toTextualString, toTextualString

Methods inherited from class org.djunits.value.base.Scalar

format, format, getDisplayUnit, setDisplayUnit

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.djunits.value.Value

isAbsolute, isRelative

Field Details

ZERO

public static final FloatLuminousFlux ZERO

Constant with value zero.

ONE

public static final FloatLuminousFlux ONE

Constant with value one.

NaN

public static final FloatLuminousFlux NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final FloatLuminousFlux POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatLuminousFlux NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatLuminousFlux POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatLuminousFlux NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

FloatLuminousFlux

public FloatLuminousFlux(float value,
 LuminousFluxUnit unit)

Construct FloatLuminousFlux scalar.

Parameters:

value - float; the float value

unit - unit for the float value

FloatLuminousFlux

public FloatLuminousFlux(FloatLuminousFlux value)

Construct FloatLuminousFlux scalar.

Parameters:

value - Scalar from which to construct this instance

FloatLuminousFlux

public FloatLuminousFlux(double value,
 LuminousFluxUnit unit)

Construct FloatLuminousFlux scalar using a double value.

Parameters:

value - double; the double value

unit - unit for the resulting float value

Method Details

instantiateRel

public final FloatLuminousFlux instantiateRel(float value,
 LuminousFluxUnit unit)

Construct a new Relative Immutable FloatScalar of the right type. Each extending class must implement this method.

Specified by:

instantiateRel in class FloatScalarRel<LuminousFluxUnit,FloatLuminousFlux>

Parameters:

value - float; the float value

unit - U; the unit

Returns:

R a new relative instance of the FloatScalar of the right type

instantiateSI

public static final FloatLuminousFlux instantiateSI(float value)

Construct FloatLuminousFlux scalar.

Parameters:

value - float; the float value in SI units

Returns:

the new scalar with the SI value

interpolate

public static FloatLuminousFlux interpolate(FloatLuminousFlux zero,
 FloatLuminousFlux one,
 float ratio)

Interpolate between two values.

Parameters:

zero - the low value

one - the high value

ratio - double; the ratio between 0 and 1, inclusive

Returns:

a Scalar at the ratio between

max

public static FloatLuminousFlux max(FloatLuminousFlux r1,
 FloatLuminousFlux 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 FloatLuminousFlux max(FloatLuminousFlux r1,
 FloatLuminousFlux r2,
 FloatLuminousFlux... 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 FloatLuminousFlux min(FloatLuminousFlux r1,
 FloatLuminousFlux 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 FloatLuminousFlux min(FloatLuminousFlux r1,
 FloatLuminousFlux r2,
 FloatLuminousFlux... 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 FloatLuminousFlux valueOf(String text)

Returns a FloatLuminousFlux 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 - String; the textual representation to parse into a FloatLuminousFlux

Returns:

FloatLuminousFlux; 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 FloatLuminousFlux of(float value,
 String unitString)

Returns a FloatLuminousFlux based on a value and the textual representation of the unit, which can be localized.

Parameters:

value - double; the value to use

unitString - String; the textual representation of the unit

Returns:

FloatLuminousFlux; 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(FloatLuminousFlux v)

Calculate the division of FloatLuminousFlux and FloatLuminousFlux, which results in a FloatDimensionless scalar.

Parameters:

v - FloatLuminousFlux; scalar

Returns:

FloatDimensionless; scalar as a division of FloatLuminousFlux and FloatLuminousFlux

divide

public final FloatIlluminance divide(FloatArea v)

Calculate the division of FloatLuminousFlux and FloatArea, which results in a FloatIlluminance scalar.

Parameters:

v - FloatLuminousFlux; scalar

Returns:

FloatIlluminance; scalar as a division of FloatLuminousFlux and FloatArea

divide

public final FloatArea divide(FloatIlluminance v)

Calculate the division of FloatLuminousFlux and FloatIlluminance, which results in a FloatArea scalar.

Parameters:

v - FloatLuminousFlux; scalar

Returns:

FloatArea; scalar as a division of FloatLuminousFlux and FloatIlluminance

divide

public final FloatSolidAngle divide(FloatLuminousIntensity v)

Calculate the division of FloatLuminousFlux and FloatLuminousIntensity, which results in a FloatSolidAngle scalar.

Parameters:

v - FloatLuminousFlux; scalar

Returns:

FloatSolidAngle; scalar as a division of FloatLuminousFlux and FloatLuminousIntensity

divide

public final FloatLuminousIntensity divide(FloatSolidAngle v)

Calculate the division of FloatLuminousFlux and FloatSolidAngle, which results in a FloatLuminousIntensity scalar.

Parameters:

v - FloatLuminousFlux; scalar

Returns:

FloatLuminousIntensity; scalar as a division of FloatLuminousFlux and FloatSolidAngle

reciprocal

public FloatSIScalar reciprocal()

Create the reciprocal of this scalar with the correct dimensions.

Specified by:

reciprocal in class FloatScalarRel<LuminousFluxUnit,FloatLuminousFlux>

Returns:

FloatScalar<?>; a new scalar instance with correct SI dimensions