org.djunits.value.vfloat.scalar

Class FloatArea

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vfloat.scalar.AbstractFloatScalar<U,R>

org.djunits.value.vfloat.scalar.AbstractFloatScalarRel<AreaUnit,FloatArea>

org.djunits.value.vfloat.scalar.FloatArea

All Implemented Interfaces:

Serializable, Comparable<FloatArea>, MathFunctionsAbs<FloatArea>, MathFunctionsRel<FloatArea>, Relative, Value<AreaUnit>, FloatMathFunctions<FloatArea>, FloatScalarInterface

public class FloatArea
extends AbstractFloatScalarRel<AreaUnit,FloatArea>

Easy access methods for the Area FloatScalar, which is relative by definition. An example is Speed. Instead of:

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

we can now write:

 FloatArea value = new FloatArea(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 FloatArea	NaN constant with value NaN.
static FloatArea	NEG_MAXVALUE constant with value -MAX_VALUE.
static FloatArea	NEGATIVE_INFINITY constant with value NEGATIVE_INFINITY.
static FloatArea	POS_MAXVALUE constant with value MAX_VALUE.
static FloatArea	POSITIVE_INFINITY constant with value POSITIVE_INFINITY.
static FloatArea	ZERO constant with value zero.

Fields inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalar

si

Fields inherited from class org.djunits.value.Scalar

NUMBER_PATTERN

Fields inherited from interface org.djunits.value.vfloat.FloatMathFunctions

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static FloatArea	createSI(float value) Construct FloatArea scalar.
FloatDimensionless	divideBy(FloatArea v) Calculate the division of FloatArea and FloatArea, which results in a FloatDimensionless scalar.
FloatLength	divideBy(FloatLength v) Calculate the division of FloatArea and FloatLength, which results in a FloatLength scalar.
FloatVolume	divideBy(FloatLinearDensity v) Calculate the division of FloatArea and FloatLinearDensity, which results in a FloatVolume scalar.
FloatLinearDensity	divideBy(FloatVolume v) Calculate the division of FloatArea and FloatVolume, which results in a FloatLinearDensity scalar.
FloatArea	instantiateRel(float value, AreaUnit unit) Construct a new Relative Immutable FloatScalar of the right type.
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.
FloatVolume	multiplyBy(FloatLength v) Calculate the multiplication of FloatArea and FloatLength, which results in a FloatVolume scalar.
FloatLength	multiplyBy(FloatLinearDensity v) Calculate the multiplication of FloatArea and FloatLinearDensity, which results in a FloatLength scalar.
FloatMoney	multiplyBy(FloatMoneyPerArea v) Calculate the multiplication of FloatArea and FloatMoneyPerArea, which results in a FloatMoney scalar.
FloatForce	multiplyBy(FloatPressure v) Calculate the multiplication of FloatArea and FloatPressure, which results in a FloatForce scalar.
FloatFlowVolume	multiplyBy(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.AbstractFloatScalarRel

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

Methods inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalar

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.vfloat.FloatMathFunctions

DIV, MULT, POW

Field Detail

ZERO

public static final FloatArea ZERO

constant with value zero.

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 Detail

FloatArea

public FloatArea(float value,
                 AreaUnit unit)

Construct FloatArea scalar.

Parameters:

value - 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 value

unit - unit for the resulting float value

Method Detail

instantiateRel

public final FloatArea instantiateRel(float value,
                                      AreaUnit unit)

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

Specified by:

instantiateRel in class AbstractFloatScalarRel<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

createSI

public static final FloatArea createSI(float value)

Construct FloatArea scalar.

Parameters:

value - 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 - 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)
                         throws IllegalArgumentException

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

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 FloatDimensionless divideBy(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

multiplyBy

public final FloatVolume multiplyBy(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

divideBy

public final FloatVolume divideBy(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

divideBy

public final FloatLinearDensity divideBy(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

divideBy

public final FloatLength divideBy(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

multiplyBy

public final FloatLength multiplyBy(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

multiplyBy

public final FloatFlowVolume multiplyBy(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

multiplyBy

public final FloatForce multiplyBy(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

multiplyBy

public final FloatMoney multiplyBy(FloatMoneyPerArea v)

Calculate the multiplication of FloatArea and FloatMoneyPerArea, which results in a FloatMoney scalar.

Parameters:

v - FloatArea scalar

Returns:

FloatMoney scalar as a multiplication of FloatArea and FloatMoneyPerArea