org.djunits.value.vfloat.scalar

Class FloatMoneyPerArea

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<MoneyPerAreaUnit,FloatMoneyPerArea>

org.djunits.value.vfloat.scalar.FloatMoneyPerArea

All Implemented Interfaces:

Serializable, Comparable<FloatMoneyPerArea>, MathFunctionsAbs<FloatMoneyPerArea>, MathFunctionsRel<FloatMoneyPerArea>, Relative, Value<MoneyPerAreaUnit>, FloatMathFunctions<FloatMoneyPerArea>, FloatScalarInterface

public class FloatMoneyPerArea
extends AbstractFloatScalarRel<MoneyPerAreaUnit,FloatMoneyPerArea>

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

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

we can now write:

 FloatMoneyPerArea value = new FloatMoneyPerArea(100.0, MoneyPerAreaUnit.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-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

$LastChangedDate: 2018-01-28 03:17:44 +0100 (Sun, 28 Jan 2018) $, @version $Revision: 256 $, by $Author: averbraeck $, initial version Sep 5, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

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

si

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
FloatMoneyPerArea(double value, MoneyPerAreaUnit unit) Construct FloatMoneyPerArea scalar using a double value.
FloatMoneyPerArea(FloatMoneyPerArea value) Construct FloatMoneyPerArea scalar.
FloatMoneyPerArea(float value, MoneyPerAreaUnit unit) Construct FloatMoneyPerArea scalar.

Method Summary

Modifier and Type	Method and Description
FloatDimensionless	divideBy(FloatMoneyPerArea v) Calculate the division of FloatMoneyPerArea and FloatMoneyPerArea, which results in a FloatDimensionless scalar.
FloatMoneyPerArea	instantiateRel(float value, MoneyPerAreaUnit unit) Construct a new Relative Immutable FloatScalar of the right type.
static FloatMoneyPerArea	interpolate(FloatMoneyPerArea zero, FloatMoneyPerArea one, float ratio) Interpolate between two values.
static FloatMoneyPerArea	max(FloatMoneyPerArea r1, FloatMoneyPerArea r2) Return the maximum value of two monetary scalars.
static FloatMoneyPerArea	max(FloatMoneyPerArea r1, FloatMoneyPerArea r2, FloatMoneyPerArea... rn) Return the maximum value of more than two monetary scalars.
static FloatMoneyPerArea	min(FloatMoneyPerArea r1, FloatMoneyPerArea r2) Return the minimum value of two monetary scalars.
static FloatMoneyPerArea	min(FloatMoneyPerArea r1, FloatMoneyPerArea r2, FloatMoneyPerArea... rn) Return the minimum value of more than two monetary scalars.
FloatMoney	multiplyBy(FloatArea v) Calculate the multiplication of FloatMoneyPerArea and FloatArea, which results in a FloatMoney scalar.

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

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

Constructor Detail

FloatMoneyPerArea

public FloatMoneyPerArea(float value,
                         MoneyPerAreaUnit unit)

Construct FloatMoneyPerArea scalar.

Parameters:

value - float value

unit - unit for the float value

FloatMoneyPerArea

public FloatMoneyPerArea(FloatMoneyPerArea value)

Construct FloatMoneyPerArea scalar.

Parameters:

value - Scalar from which to construct this instance

FloatMoneyPerArea

public FloatMoneyPerArea(double value,
                         MoneyPerAreaUnit unit)

Construct FloatMoneyPerArea scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

Method Detail

instantiateRel

public final FloatMoneyPerArea instantiateRel(float value,
                                              MoneyPerAreaUnit unit)

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

Specified by:

instantiateRel in class AbstractFloatScalarRel<MoneyPerAreaUnit,FloatMoneyPerArea>

Parameters:

value - the float value

unit - the unit

Returns:

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

interpolate

public static FloatMoneyPerArea interpolate(FloatMoneyPerArea zero,
                                            FloatMoneyPerArea 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 FloatMoneyPerArea max(FloatMoneyPerArea r1,
                                    FloatMoneyPerArea r2)

Return the maximum value of two monetary scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

Returns:

the maximum value of two monetary scalars

max

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

Return the maximum value of more than two monetary scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

rn - the other scalars

Returns:

the maximum value of more than two monetary scalars

min

public static FloatMoneyPerArea min(FloatMoneyPerArea r1,
                                    FloatMoneyPerArea r2)

Return the minimum value of two monetary scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

Returns:

the minimum value of two monetary scalars

min

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

Return the minimum value of more than two monetary scalars.

Parameters:

r1 - the first scalar

r2 - the second scalar

rn - the other scalars

Returns:

the minimum value of more than two monetary scalars

divideBy

public final FloatDimensionless divideBy(FloatMoneyPerArea v)

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

Parameters:

v - FloatMoneyPerArea scalar

Returns:

FloatDimensionless scalar as a division of FloatMoneyPerArea and FloatMoneyPerArea

multiplyBy

public final FloatMoney multiplyBy(FloatArea v)

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

Parameters:

v - FloatMoneyPerArea scalar

Returns:

FloatMoney scalar as a multiplication of FloatMoneyPerArea and FloatArea