Package org.djunits.value.vdouble.scalar

Class LinearDensity

java.lang.Object

java.lang.Number

org.djunits.value.base.Scalar<U,S>

org.djunits.value.vdouble.scalar.base.DoubleScalar<U,R>

org.djunits.value.vdouble.scalar.base.DoubleScalarRel<LinearDensityUnit,LinearDensity>

org.djunits.value.vdouble.scalar.LinearDensity

All Implemented Interfaces:

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

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

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

Fields inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar

si

Constructor Summary

Constructors

Constructor	Description
LinearDensity(double value, LinearDensityUnit unit)	Construct LinearDensity scalar.
LinearDensity(LinearDensity value)	Construct LinearDensity scalar.

Method Summary

Modifier and Type	Method	Description
final Dimensionless	divide(LinearDensity v)	Calculate the division of LinearDensity and LinearDensity, which results in a Dimensionless scalar.
final LinearDensity	instantiateRel(double value, LinearDensityUnit unit)	Construct a new Relative Immutable DoubleScalar of the right type.
static final LinearDensity	instantiateSI(double value)	Construct LinearDensity scalar.
static LinearDensity	interpolate(LinearDensity zero, LinearDensity one, double ratio)	Interpolate between two values.
static LinearDensity	max(LinearDensity r1, LinearDensity r2)	Return the maximum value of two relative scalars.
static LinearDensity	max(LinearDensity r1, LinearDensity r2, LinearDensity... rn)	Return the maximum value of more than two relative scalars.
static LinearDensity	min(LinearDensity r1, LinearDensity r2)	Return the minimum value of two relative scalars.
static LinearDensity	min(LinearDensity r1, LinearDensity r2, LinearDensity... rn)	Return the minimum value of more than two relative scalars.
static LinearDensity	of(double value, String unitString)	Returns a LinearDensity based on a value and the textual representation of the unit, which can be localized.
Length	reciprocal()	Create the reciprocal of this scalar with the correct dimensions.
final Length	times(Area v)	Calculate the multiplication of LinearDensity and Area, which results in a Length scalar.
final Force	times(Energy v)	Calculate the multiplication of LinearDensity and Energy, which results in a Force scalar.
final Dimensionless	times(Length v)	Calculate the multiplication of LinearDensity and Length, which results in a Dimensionless scalar.
final Frequency	times(Speed v)	Calculate the multiplication of LinearDensity and Speed, which results in a Frequency scalar.
static LinearDensity	valueOf(String text)	Returns a LinearDensity representation of a textual representation of a value with a unit.

Methods inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalarRel

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

Methods inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar

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 LinearDensity ZERO

Constant with value zero.

ONE

public static final LinearDensity ONE

Constant with value one.

NaN

public static final LinearDensity NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final LinearDensity POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final LinearDensity NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final LinearDensity POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final LinearDensity NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

LinearDensity

public LinearDensity(double value,
 LinearDensityUnit unit)

Construct LinearDensity scalar.

Parameters:

value - double; the double value

unit - LinearDensityUnit; unit for the double value

LinearDensity

public LinearDensity(LinearDensity value)

Construct LinearDensity scalar.

Parameters:

value - LinearDensity; Scalar from which to construct this instance

Method Details

instantiateRel

public final LinearDensity instantiateRel(double value,
 LinearDensityUnit unit)

Description copied from class: DoubleScalarRel

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

Specified by:

instantiateRel in class DoubleScalarRel<LinearDensityUnit,LinearDensity>

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 LinearDensity instantiateSI(double value)

Construct LinearDensity scalar.

Parameters:

value - double; the double value in SI units

Returns:

LinearDensity; the new scalar with the SI value

interpolate

public static LinearDensity interpolate(LinearDensity zero,
 LinearDensity one,
 double ratio)

Interpolate between two values.

Parameters:

zero - LinearDensity; the low value

one - LinearDensity; the high value

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

Returns:

LinearDensity; a Scalar at the ratio between

max

public static LinearDensity max(LinearDensity r1,
 LinearDensity r2)

Return the maximum value of two relative scalars.

Parameters:

r1 - LinearDensity; the first scalar

r2 - LinearDensity; the second scalar

Returns:

LinearDensity; the maximum value of two relative scalars

max

public static LinearDensity max(LinearDensity r1,
 LinearDensity r2,
 LinearDensity... rn)

Return the maximum value of more than two relative scalars.

Parameters:

r1 - LinearDensity; the first scalar

r2 - LinearDensity; the second scalar

rn - LinearDensity...; the other scalars

Returns:

LinearDensity; the maximum value of more than two relative scalars

min

public static LinearDensity min(LinearDensity r1,
 LinearDensity r2)

Return the minimum value of two relative scalars.

Parameters:

r1 - LinearDensity; the first scalar

r2 - LinearDensity; the second scalar

Returns:

LinearDensity; the minimum value of two relative scalars

min

public static LinearDensity min(LinearDensity r1,
 LinearDensity r2,
 LinearDensity... rn)

Return the minimum value of more than two relative scalars.

Parameters:

r1 - LinearDensity; the first scalar

r2 - LinearDensity; the second scalar

rn - LinearDensity...; the other scalars

Returns:

LinearDensity; the minimum value of more than two relative scalars

valueOf

public static LinearDensity valueOf(String text)

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

Returns:

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

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

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

Calculate the division of LinearDensity and LinearDensity, which results in a Dimensionless scalar.

Parameters:

v - LinearDensity; scalar

Returns:

Dimensionless; scalar as a division of LinearDensity and LinearDensity

times

public final Dimensionless times(Length v)

Calculate the multiplication of LinearDensity and Length, which results in a Dimensionless scalar.

Parameters:

v - LinearDensity; scalar

Returns:

Dimensionless; scalar as a multiplication of LinearDensity and Length

times

public final Length times(Area v)

Calculate the multiplication of LinearDensity and Area, which results in a Length scalar.

Parameters:

v - LinearDensity; scalar

Returns:

Length; scalar as a multiplication of LinearDensity and Area

times

public final Force times(Energy v)

Calculate the multiplication of LinearDensity and Energy, which results in a Force scalar.

Parameters:

v - LinearDensity; scalar

Returns:

Force; scalar as a multiplication of LinearDensity and Energy

times

public final Frequency times(Speed v)

Calculate the multiplication of LinearDensity and Speed, which results in a Frequency scalar.

Parameters:

v - LinearDensity; scalar

Returns:

Frequency; scalar as a multiplication of LinearDensity and Speed

reciprocal

public Length reciprocal()

Description copied from class: DoubleScalarRel

Create the reciprocal of this scalar with the correct dimensions.

Specified by:

reciprocal in class DoubleScalarRel<LinearDensityUnit,LinearDensity>

Returns:

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