Package org.djunits.value.vfloat.scalar

Class FloatLinearDensity

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<LinearDensityUnit,FloatLinearDensity>

org.djunits.value.vfloat.scalar.FloatLinearDensity

All Implemented Interfaces:

Serializable, Cloneable, Comparable<FloatLinearDensity>, Relative<LinearDensityUnit,FloatLinearDensity>, Value<LinearDensityUnit,FloatLinearDensity>

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

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

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

si

Constructor Summary

Constructors

Constructor	Description
FloatLinearDensity(double value, LinearDensityUnit unit)	Construct FloatLinearDensity scalar using a double value.
FloatLinearDensity(float value, LinearDensityUnit unit)	Construct FloatLinearDensity scalar.
FloatLinearDensity(FloatLinearDensity value)	Construct FloatLinearDensity scalar.

Method Summary

Modifier and Type	Method	Description
final FloatDimensionless	divide(FloatLinearDensity v)	Calculate the division of FloatLinearDensity and FloatLinearDensity, which results in a FloatDimensionless scalar.
final FloatLinearDensity	instantiateRel(float value, LinearDensityUnit unit)	Construct a new Relative Immutable FloatScalar of the right type.
static final FloatLinearDensity	instantiateSI(float value)	Construct FloatLinearDensity scalar.
static FloatLinearDensity	interpolate(FloatLinearDensity zero, FloatLinearDensity one, float ratio)	Interpolate between two values.
static FloatLinearDensity	max(FloatLinearDensity r1, FloatLinearDensity r2)	Return the maximum value of two relative scalars.
static FloatLinearDensity	max(FloatLinearDensity r1, FloatLinearDensity r2, FloatLinearDensity... rn)	Return the maximum value of more than two relative scalars.
static FloatLinearDensity	min(FloatLinearDensity r1, FloatLinearDensity r2)	Return the minimum value of two relative scalars.
static FloatLinearDensity	min(FloatLinearDensity r1, FloatLinearDensity r2, FloatLinearDensity... rn)	Return the minimum value of more than two relative scalars.
static FloatLinearDensity	of(float value, String unitString)	Returns a FloatLinearDensity based on a value and the textual representation of the unit, which can be localized.
FloatLength	reciprocal()	Create the reciprocal of this scalar with the correct dimensions.
final FloatLength	times(FloatArea v)	Calculate the multiplication of FloatLinearDensity and FloatArea, which results in a FloatLength scalar.
final FloatForce	times(FloatEnergy v)	Calculate the multiplication of FloatLinearDensity and FloatEnergy, which results in a FloatForce scalar.
final FloatDimensionless	times(FloatLength v)	Calculate the multiplication of FloatLinearDensity and FloatLength, which results in a FloatDimensionless scalar.
final FloatFrequency	times(FloatSpeed v)	Calculate the multiplication of FloatLinearDensity and FloatSpeed, which results in a FloatFrequency scalar.
static FloatLinearDensity	valueOf(String text)	Returns a FloatLinearDensity 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 FloatLinearDensity ZERO

Constant with value zero.

ONE

public static final FloatLinearDensity ONE

Constant with value one.

NaN

public static final FloatLinearDensity NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final FloatLinearDensity POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatLinearDensity NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatLinearDensity POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatLinearDensity NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

FloatLinearDensity

public FloatLinearDensity(float value,
 LinearDensityUnit unit)

Construct FloatLinearDensity scalar.

Parameters:

value - float; the float value

unit - unit for the float value

FloatLinearDensity

public FloatLinearDensity(FloatLinearDensity value)

Construct FloatLinearDensity scalar.

Parameters:

value - Scalar from which to construct this instance

FloatLinearDensity

public FloatLinearDensity(double value,
 LinearDensityUnit unit)

Construct FloatLinearDensity scalar using a double value.

Parameters:

value - double; the double value

unit - unit for the resulting float value

Method Details

instantiateRel

public final FloatLinearDensity instantiateRel(float value,
 LinearDensityUnit 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<LinearDensityUnit,FloatLinearDensity>

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

Construct FloatLinearDensity scalar.

Parameters:

value - float; the float value in SI units

Returns:

the new scalar with the SI value

interpolate

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

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

Returns:

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

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

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

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

Parameters:

v - FloatLinearDensity; scalar

Returns:

FloatDimensionless; scalar as a division of FloatLinearDensity and FloatLinearDensity

times

public final FloatDimensionless times(FloatLength v)

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

Parameters:

v - FloatLinearDensity; scalar

Returns:

FloatDimensionless; scalar as a multiplication of FloatLinearDensity and FloatLength

times

public final FloatLength times(FloatArea v)

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

Parameters:

v - FloatLinearDensity; scalar

Returns:

FloatLength; scalar as a multiplication of FloatLinearDensity and FloatArea

times

public final FloatForce times(FloatEnergy v)

Calculate the multiplication of FloatLinearDensity and FloatEnergy, which results in a FloatForce scalar.

Parameters:

v - FloatLinearDensity; scalar

Returns:

FloatForce; scalar as a multiplication of FloatLinearDensity and FloatEnergy

times

public final FloatFrequency times(FloatSpeed v)

Calculate the multiplication of FloatLinearDensity and FloatSpeed, which results in a FloatFrequency scalar.

Parameters:

v - FloatLinearDensity; scalar

Returns:

FloatFrequency; scalar as a multiplication of FloatLinearDensity and FloatSpeed

reciprocal

public FloatLength reciprocal()

Description copied from class: FloatScalarRel

Create the reciprocal of this scalar with the correct dimensions.

Specified by:

reciprocal in class FloatScalarRel<LinearDensityUnit,FloatLinearDensity>

Returns:

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