org.djunits.value.vdouble.scalar

Class Area

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vdouble.scalar.AbstractDoubleScalar<U,R>

org.djunits.value.vdouble.scalar.AbstractDoubleScalarRel<AreaUnit,Area>

org.djunits.value.vdouble.scalar.Area

All Implemented Interfaces:

Serializable, Comparable<Area>, MathFunctionsAbs<Area>, MathFunctionsRel<Area>, Relative, Value<AreaUnit>, DoubleMathFunctions<Area>, DoubleScalarInterface

public class Area
extends AbstractDoubleScalarRel<AreaUnit,Area>

Easy access methods for the Area DoubleScalar, which is relative by definition. Instead of:

 DoubleScalar.Rel<AreaUnit> value = new DoubleScalar.Rel<AreaUnit>(100.0, AreaUnit.SI);
 

we can now write:

 Area value = new Area(100.0, AreaUnit.SI);
 

The compiler will automatically recognize which units belong to which quantity, and whether the quantity type and the unit used are compatible.

Copyright (c) 2013-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

$LastChangedDate: 2019-03-03 00:53:50 +0100 (Sun, 03 Mar 2019) $, @version $Revision: 349 $, by $Author: averbraeck $, initial version Sep 5, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Area	NaN constant with value NaN.
static Area	NEG_MAXVALUE constant with value -MAX_VALUE.
static Area	NEGATIVE_INFINITY constant with value NEGATIVE_INFINITY.
static Area	POS_MAXVALUE constant with value MAX_VALUE.
static Area	POSITIVE_INFINITY constant with value POSITIVE_INFINITY.
static Area	ZERO constant with value zero.

Fields inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalar

si

Fields inherited from class org.djunits.value.Scalar

NUMBER_PATTERN

Fields inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, NEG, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH

Constructor Summary

Constructors

Constructor and Description
Area(Area value) Construct Area scalar.
Area(double value, AreaUnit unit) Construct Area scalar.

Method Summary

Modifier and Type	Method and Description
static Area	createSI(double value) Construct Area scalar.
Dimensionless	divideBy(Area v) Calculate the division of Area and Area, which results in a Dimensionless scalar.
Length	divideBy(Length v) Calculate the division of Area and Length, which results in a Length scalar.
Volume	divideBy(LinearDensity v) Calculate the division of Area and LinearDensity, which results in a Volume scalar.
LinearDensity	divideBy(Volume v) Calculate the division of Area and Volume, which results in a LinearDensity scalar.
Area	instantiateRel(double value, AreaUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
static Area	interpolate(Area zero, Area one, double ratio) Interpolate between two values.
static Area	max(Area r1, Area r2) Return the maximum value of two relative scalars.
static Area	max(Area r1, Area r2, Area... rn) Return the maximum value of more than two relative scalars.
static Area	min(Area r1, Area r2) Return the minimum value of two relative scalars.
static Area	min(Area r1, Area r2, Area... rn) Return the minimum value of more than two relative scalars.
Volume	multiplyBy(Length v) Calculate the multiplication of Area and Length, which results in a Volume scalar.
Length	multiplyBy(LinearDensity v) Calculate the multiplication of Area and LinearDensity, which results in a Length scalar.
Money	multiplyBy(MoneyPerArea v) Calculate the multiplication of Area and MoneyPerArea, which results in a Money scalar.
Force	multiplyBy(Pressure v) Calculate the multiplication of Area and Pressure, which results in a Force scalar.
FlowVolume	multiplyBy(Speed v) Calculate the multiplication of Area and Speed, which results in a FlowVolume scalar.
static Area	valueOf(String text) Returns a Area representation of a textual representation of a value with a unit.

Methods inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalarRel

abs, ceil, divideBy, floor, minus, multiplyBy, neg, plus, rint, round

Methods inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalar

compareTo, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, intValue, le, le0, longValue, lt, lt0, ne, ne0, toString, toString, toString, toString

Methods inherited from class org.djunits.value.Scalar

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative, setDisplayUnit, stringOf, stringOfDefaultLocale, textualStringOf, textualStringOfDefaultLocale

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.vdouble.DoubleMathFunctions

DIV, MULT, POW

Field Detail

ZERO

public static final Area ZERO

constant with value zero.

NaN

public static final Area NaN

constant with value NaN.

POSITIVE_INFINITY

public static final Area POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final Area NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final Area POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final Area NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

Area

public Area(double value,
            AreaUnit unit)

Construct Area scalar.

Parameters:

value - double value

unit - unit for the double value

Area

public Area(Area value)

Construct Area scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateRel

public final Area instantiateRel(double value,
                                 AreaUnit unit)

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

Specified by:

instantiateRel in class AbstractDoubleScalarRel<AreaUnit,Area>

Parameters:

value - double; the double value

unit - U; the unit

Returns:

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

createSI

public static final Area createSI(double value)

Construct Area scalar.

Parameters:

value - double value in SI units

Returns:

the new scalar with the SI value

interpolate

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

Interpolate between two values.

Parameters:

zero - the low value

one - the high value

ratio - the ratio between 0 and 1, inclusive

Returns:

a Scalar at the ratio between

max

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

Returns a Area 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 the official abbreviation of the unit. Spaces are allowed, but not necessary, between the value and the unit.

Parameters:

text - String; the textual representation to parse into a Area

Returns:

the String representation of the value in its unit, followed by the official abbreviation of the unit

Throws:

IllegalArgumentException - when the text cannot be parsed

divideBy

public final Dimensionless divideBy(Area v)

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

Parameters:

v - Area scalar

Returns:

Dimensionless scalar as a division of Area and Area

multiplyBy

public final Volume multiplyBy(Length v)

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

Parameters:

v - Area scalar

Returns:

Volume scalar as a multiplication of Area and Length

divideBy

public final Volume divideBy(LinearDensity v)

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

Parameters:

v - Area scalar

Returns:

Volume scalar as a division of Area and LinearDensity

divideBy

public final LinearDensity divideBy(Volume v)

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

Parameters:

v - Area scalar

Returns:

LinearDensity scalar as a division of Area and Volume

divideBy

public final Length divideBy(Length v)

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

Parameters:

v - Area scalar

Returns:

Length scalar as a division of Area and Length

multiplyBy

public final Length multiplyBy(LinearDensity v)

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

Parameters:

v - Area scalar

Returns:

Length scalar as a multiplication of Area and LinearDensity

multiplyBy

public final FlowVolume multiplyBy(Speed v)

Calculate the multiplication of Area and Speed, which results in a FlowVolume scalar.

Parameters:

v - Area scalar

Returns:

FlowVolume scalar as a multiplication of Area and Speed

multiplyBy

public final Force multiplyBy(Pressure v)

Calculate the multiplication of Area and Pressure, which results in a Force scalar.

Parameters:

v - Area scalar

Returns:

Force scalar as a multiplication of Area and Pressure

multiplyBy

public final Money multiplyBy(MoneyPerArea v)

Calculate the multiplication of Area and MoneyPerArea, which results in a Money scalar.

Parameters:

v - Area scalar

Returns:

Money scalar as a multiplication of Area and MoneyPerArea