Package org.djunits.quantity

Class LinearObjectDensity

java.lang.Object

java.lang.Number

org.djunits.quantity.def.Quantity<LinearObjectDensity>

org.djunits.quantity.LinearObjectDensity

All Implemented Interfaces:

Serializable, Comparable<LinearObjectDensity>, Additive<LinearObjectDensity>, Scalable<LinearObjectDensity>, Value<LinearObjectDensity>

public class LinearObjectDensity
extends Quantity<LinearObjectDensity>

Linear object density counts the number of objects per unit of length, measured in number per meter (/m).

Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://djunits.org. The DJUNITS project is distributed under a three-clause BSD-style license.

Author:

Alexander Verbraeck

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LinearObjectDensity.Unit	LinearObjectDensity.Unit encodes the unit for the number of objects per unit of length.

Field Summary

Fields

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

Fields inherited from class org.djunits.quantity.def.Quantity

si

Constructor Summary

Constructors

Constructor	Description
LinearObjectDensity(double valueInUnit, LinearObjectDensity.Unit unit)	Instantiate a LinearObjectDensity quantity expressed in the given unit.
LinearObjectDensity(double value, LinearObjectDensity.Unit displayUnit, boolean useSi)	Instantiate a LinearObjectDensity quantity with an SI or base value and a display unit.

Method Summary

Modifier and Type	Method	Description
Dimensionless	divide(LinearObjectDensity v)	Calculate the division of LinearObjectDensity and LinearObjectDensity, which results in a Dimensionless quantity.
LinearObjectDensity.Unit	getDisplayUnit()	Retrieve the unit of this Value.
LinearObjectDensity	instantiateSi(double siValue, UnitInterface<LinearObjectDensity> displayUnit)	Instantiate a quantity with an SI or base value, and a display unit.
Length	multiply(Area v)	Calculate the multiplication of LinearObjectDensity and Area, which results in a Length scalar.
Force	multiply(Energy v)	Calculate the multiplication of LinearObjectDensity and Energy, which results in a Force scalar.
Dimensionless	multiply(Length v)	Calculate the multiplication of LinearObjectDensity and Length, which results in a Dimensionless scalar.
Frequency	multiply(Speed v)	Calculate the multiplication of LinearObjectDensity and Speed, which results in a Frequency scalar.
static LinearObjectDensity	of(double valueInUnit, String unitString)	Returns a LinearObjectDensity based on a value and the textual representation of the unit, which can be localized.
static LinearObjectDensity	of(double valueInUnit, LinearObjectDensity.Unit unit)	Returns a LinearObjectDensity based on a value expressed in the unit.
static LinearObjectDensity	ofSi(double si)	Return a LinearObjectDensity instance based on an SI value.
static LinearObjectDensity	ofSi(double siValue, LinearObjectDensity.Unit displayUnit)	Instantiate a LinearObjectDensity quantity with an SI or base value and a display unit.
Length	reciprocal()	Return the reciprocal of this quantity (1/q).
static LinearObjectDensity	valueOf(String text)	Returns a LinearObjectDensity representation of a textual representation of a value with a unit.

Methods inherited from class org.djunits.quantity.def.Quantity

abs, add, as, compareTo, divide, doubleValue, eq, eq0, equals, floatValue, format, format, format, ge, ge0, getInUnit, getInUnit, getName, gt, gt0, hashCode, instantiate, instantiateSi, interpolate, intValue, isRelative, le, le0, longValue, lt, lt0, max, mean, min, multiply, ne, ne0, negate, of, product, scaleBy, si, siUnit, subtract, sum, toString, valueOf

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.Scalable

divideBy

Methods inherited from interface org.djunits.value.Value

isAbsolute

Field Details

ZERO

public static final LinearObjectDensity ZERO

Constant with value zero.

ONE

public static final LinearObjectDensity ONE

Constant with value one.

NaN

public static final LinearObjectDensity NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final LinearObjectDensity POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final LinearObjectDensity NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final LinearObjectDensity POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final LinearObjectDensity NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

LinearObjectDensity

public LinearObjectDensity(double value,
 LinearObjectDensity.Unit displayUnit,
 boolean useSi)

Instantiate a LinearObjectDensity quantity with an SI or base value and a display unit.

Parameters:

value - the quantity value expressed in the SI or base unit

displayUnit - the display unit to use

useSi - use SI value when true, use value in unit when false

LinearObjectDensity

public LinearObjectDensity(double valueInUnit,
 LinearObjectDensity.Unit unit)

Instantiate a LinearObjectDensity quantity expressed in the given unit.

Parameters:

valueInUnit - the quantity value expressed in the given unit

unit - the unit of the value, also acts as the display unit

Method Details

ofSi

public static LinearObjectDensity ofSi(double si)

Return a LinearObjectDensity instance based on an SI value.

Parameters:

si - the si value

Returns:

the LinearObjectDensity instance based on an SI value

ofSi

public static LinearObjectDensity ofSi(double siValue,
 LinearObjectDensity.Unit displayUnit)

Instantiate a LinearObjectDensity quantity with an SI or base value and a display unit.

Parameters:

siValue - the quantity value expressed in the SI or base unit

displayUnit - the display unit to use

Returns:

the LinearObjectDensity instance based on an SI value with the given display unit

instantiateSi

public LinearObjectDensity instantiateSi(double siValue,
 UnitInterface<LinearObjectDensity> displayUnit)

Description copied from class: Quantity

Instantiate a quantity with an SI or base value, and a display unit.

Specified by:

instantiateSi in class Quantity<LinearObjectDensity>

Parameters:

siValue - the value expressed in the base (SI) unit

displayUnit - the display unit to use for the quantity

Returns:

a quantity with the given SI or base value, and the given display unit

valueOf

public static LinearObjectDensity valueOf(String text)

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

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 LinearObjectDensity of(double valueInUnit,
 LinearObjectDensity.Unit unit)

Returns a LinearObjectDensity based on a value expressed in the unit.

Parameters:

valueInUnit - the value, expressed in the given unit

unit - the unit of the value, also acts as the display unit

Returns:

ab LinearObjectDensity representation of the value in its unit

of

public static LinearObjectDensity of(double valueInUnit,
 String unitString)

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

Parameters:

valueInUnit - the value, expressed in the unit as given by unitString

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

getDisplayUnit

public LinearObjectDensity.Unit getDisplayUnit()

Description copied from interface: Value

Retrieve the unit of this Value.

Specified by:

getDisplayUnit in interface Value<LinearObjectDensity>

Overrides:

getDisplayUnit in class Quantity<LinearObjectDensity>

Returns:

the unit of this Value

divide

public Dimensionless divide(LinearObjectDensity v)

Calculate the division of LinearObjectDensity and LinearObjectDensity, which results in a Dimensionless quantity.

Parameters:

v - quantity

Returns:

quantity as a division of LinearObjectDensity and LinearObjectDensity

multiply

public Dimensionless multiply(Length v)

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

Parameters:

v - scalar

Returns:

scalar as a multiplication of LinearObjectDensity and Length

multiply

public Length multiply(Area v)

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

Parameters:

v - scalar

Returns:

scalar as a multiplication of LinearObjectDensity and Area

multiply

public Force multiply(Energy v)

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

Parameters:

v - scalar

Returns:

scalar as a multiplication of LinearObjectDensity and Energy

multiply

public Frequency multiply(Speed v)

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

Parameters:

v - scalar

Returns:

scalar as a multiplication of LinearObjectDensity and Speed

reciprocal

public Length reciprocal()

Description copied from class: Quantity

Return the reciprocal of this quantity (1/q).

Overrides:

reciprocal in class Quantity<LinearObjectDensity>

Returns:

the reciprocal of this quantity, with the correct SI units