Package org.djunits.value.vfloat.scalar

Class FloatArea

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<AreaUnit,FloatArea>

org.djunits.value.vfloat.scalar.FloatArea

All Implemented Interfaces:

Serializable, Cloneable, Comparable<FloatArea>, Relative<AreaUnit,FloatArea>, Value<AreaUnit,FloatArea>

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

Easy access methods for the FloatArea 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 FloatArea	NaN	Constant with value NaN.
static final FloatArea	NEG_MAXVALUE	Constant with value -MAX_VALUE.
static final FloatArea	NEGATIVE_INFINITY	Constant with value NEGATIVE_INFINITY.
static final FloatArea	ONE	Constant with value one.
static final FloatArea	POS_MAXVALUE	Constant with value MAX_VALUE.
static final FloatArea	POSITIVE_INFINITY	Constant with value POSITIVE_INFINITY.
static final FloatArea	ZERO	Constant with value zero.

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

si

Constructor Summary

Constructors

Constructor	Description
FloatArea(double value, AreaUnit unit)	Construct FloatArea scalar using a double value.
FloatArea(float value, AreaUnit unit)	Construct FloatArea scalar.
FloatArea(FloatArea value)	Construct FloatArea scalar.

Method Summary

Modifier and Type	Method	Description
final FloatDimensionless	divide(FloatArea v)	Calculate the division of FloatArea and FloatArea, which results in a FloatDimensionless scalar.
final FloatLength	divide(FloatLength v)	Calculate the division of FloatArea and FloatLength, which results in a FloatLength scalar.
final FloatVolume	divide(FloatLinearDensity v)	Calculate the division of FloatArea and FloatLinearDensity, which results in a FloatVolume scalar.
final FloatLinearDensity	divide(FloatVolume v)	Calculate the division of FloatArea and FloatVolume, which results in a FloatLinearDensity scalar.
final FloatArea	instantiateRel(float value, AreaUnit unit)	Construct a new Relative Immutable FloatScalar of the right type.
static final FloatArea	instantiateSI(float value)	Construct FloatArea scalar.
static FloatArea	interpolate(FloatArea zero, FloatArea one, float ratio)	Interpolate between two values.
static FloatArea	max(FloatArea r1, FloatArea r2)	Return the maximum value of two relative scalars.
static FloatArea	max(FloatArea r1, FloatArea r2, FloatArea... rn)	Return the maximum value of more than two relative scalars.
static FloatArea	min(FloatArea r1, FloatArea r2)	Return the minimum value of two relative scalars.
static FloatArea	min(FloatArea r1, FloatArea r2, FloatArea... rn)	Return the minimum value of more than two relative scalars.
static FloatArea	of(float value, String unitString)	Returns a FloatArea 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.
final FloatLuminousFlux	times(FloatIlluminance v)	Calculate the multiplication of FloatArea and FloatIlluminance, which results in a FloatLuminousFlux scalar.
final FloatVolume	times(FloatLength v)	Calculate the multiplication of FloatArea and FloatLength, which results in a FloatVolume scalar.
final FloatLength	times(FloatLinearDensity v)	Calculate the multiplication of FloatArea and FloatLinearDensity, which results in a FloatLength scalar.
final FloatForce	times(FloatPressure v)	Calculate the multiplication of FloatArea and FloatPressure, which results in a FloatForce scalar.
final FloatFlowVolume	times(FloatSpeed v)	Calculate the multiplication of FloatArea and FloatSpeed, which results in a FloatFlowVolume scalar.
static FloatArea	valueOf(String text)	Returns a FloatArea 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 FloatArea ZERO

Constant with value zero.

ONE

public static final FloatArea ONE

Constant with value one.

NaN

public static final FloatArea NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final FloatArea POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatArea NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatArea POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatArea NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

FloatArea

public FloatArea(float value,
 AreaUnit unit)

Construct FloatArea scalar.

Parameters:

value - float; the float value

unit - unit for the float value

FloatArea

public FloatArea(FloatArea value)

Construct FloatArea scalar.

Parameters:

value - Scalar from which to construct this instance

FloatArea

public FloatArea(double value,
 AreaUnit unit)

Construct FloatArea scalar using a double value.

Parameters:

value - double; the double value

unit - unit for the resulting float value

Method Details

instantiateRel

public final FloatArea instantiateRel(float value,
 AreaUnit 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<AreaUnit,FloatArea>

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 FloatArea instantiateSI(float value)

Construct FloatArea scalar.

Parameters:

value - float; the float value in SI units

Returns:

the new scalar with the SI value

interpolate

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

Returns a FloatArea 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 FloatArea

Returns:

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

Returns a FloatArea 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:

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

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

Parameters:

v - FloatArea; scalar

Returns:

FloatDimensionless; scalar as a division of FloatArea and FloatArea

times

public final FloatVolume times(FloatLength v)

Calculate the multiplication of FloatArea and FloatLength, which results in a FloatVolume scalar.

Parameters:

v - FloatArea; scalar

Returns:

FloatVolume; scalar as a multiplication of FloatArea and FloatLength

divide

public final FloatVolume divide(FloatLinearDensity v)

Calculate the division of FloatArea and FloatLinearDensity, which results in a FloatVolume scalar.

Parameters:

v - FloatArea; scalar

Returns:

FloatVolume; scalar as a division of FloatArea and FloatLinearDensity

divide

public final FloatLinearDensity divide(FloatVolume v)

Calculate the division of FloatArea and FloatVolume, which results in a FloatLinearDensity scalar.

Parameters:

v - FloatArea; scalar

Returns:

FloatLinearDensity; scalar as a division of FloatArea and FloatVolume

divide

public final FloatLength divide(FloatLength v)

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

Parameters:

v - FloatArea; scalar

Returns:

FloatLength; scalar as a division of FloatArea and FloatLength

times

public final FloatLength times(FloatLinearDensity v)

Calculate the multiplication of FloatArea and FloatLinearDensity, which results in a FloatLength scalar.

Parameters:

v - FloatArea; scalar

Returns:

FloatLength; scalar as a multiplication of FloatArea and FloatLinearDensity

times

public final FloatFlowVolume times(FloatSpeed v)

Calculate the multiplication of FloatArea and FloatSpeed, which results in a FloatFlowVolume scalar.

Parameters:

v - FloatArea; scalar

Returns:

FloatFlowVolume; scalar as a multiplication of FloatArea and FloatSpeed

times

public final FloatForce times(FloatPressure v)

Calculate the multiplication of FloatArea and FloatPressure, which results in a FloatForce scalar.

Parameters:

v - FloatArea; scalar

Returns:

FloatForce; scalar as a multiplication of FloatArea and FloatPressure

times

public final FloatLuminousFlux times(FloatIlluminance v)

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

Parameters:

v - FloatArea; scalar

Returns:

FloatLuminousFlux; scalar as a multiplication of FloatArea and FloatIlluminance

reciprocal

public FloatSIScalar reciprocal()

Description copied from class: FloatScalarRel

Create the reciprocal of this scalar with the correct dimensions.

Specified by:

reciprocal in class FloatScalarRel<AreaUnit,FloatArea>

Returns:

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