org.djunits.value.vfloat.scalar

Class FloatEnergy

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<EnergyUnit,FloatEnergy>

org.djunits.value.vfloat.scalar.FloatEnergy

All Implemented Interfaces:

Serializable, Comparable<FloatEnergy>, MathFunctionsAbs<FloatEnergy>, MathFunctionsRel<FloatEnergy>, Relative, Value<EnergyUnit>, FloatMathFunctions<FloatEnergy>, FloatScalarInterface

public class FloatEnergy
extends AbstractFloatScalarRel<EnergyUnit,FloatEnergy>

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

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

we can now write:

 FloatEnergy value = new FloatEnergy(100.0, EnergyUnit.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 FloatEnergy	NaN constant with value NaN.
static FloatEnergy	NEG_MAXVALUE constant with value -MAX_VALUE.
static FloatEnergy	NEGATIVE_INFINITY constant with value NEGATIVE_INFINITY.
static FloatEnergy	POS_MAXVALUE constant with value MAX_VALUE.
static FloatEnergy	POSITIVE_INFINITY constant with value POSITIVE_INFINITY.
static FloatEnergy	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
FloatEnergy(double value, EnergyUnit unit) Construct FloatEnergy scalar using a double value.
FloatEnergy(FloatEnergy value) Construct FloatEnergy scalar.
FloatEnergy(float value, EnergyUnit unit) Construct FloatEnergy scalar.

Method Summary

Modifier and Type	Method and Description
static FloatEnergy	createSI(float value) Construct FloatEnergy scalar.
FloatPower	divideBy(FloatDuration v) Calculate the division of FloatEnergy and FloatDuration, which results in a FloatPower scalar.
FloatDimensionless	divideBy(FloatEnergy v) Calculate the division of FloatEnergy and FloatEnergy, which results in a FloatDimensionless scalar.
FloatLength	divideBy(FloatForce v) Calculate the division of FloatEnergy and FloatForce, which results in a FloatLength scalar.
FloatForce	divideBy(FloatLength v) Calculate the division of FloatEnergy and FloatLength, which results in a FloatForce scalar.
FloatDuration	divideBy(FloatPower v) Calculate the division of FloatEnergy and FloatPower, which results in a FloatDuration scalar.
FloatPressure	divideBy(FloatVolume v) Calculate the division of FloatEnergy and FloatVolume, which results in a FloatPressure scalar.
FloatEnergy	instantiateRel(float value, EnergyUnit unit) Construct a new Relative Immutable FloatScalar of the right type.
static FloatEnergy	interpolate(FloatEnergy zero, FloatEnergy one, float ratio) Interpolate between two values.
static FloatEnergy	max(FloatEnergy r1, FloatEnergy r2) Return the maximum value of two relative scalars.
static FloatEnergy	max(FloatEnergy r1, FloatEnergy r2, FloatEnergy... rn) Return the maximum value of more than two relative scalars.
static FloatEnergy	min(FloatEnergy r1, FloatEnergy r2) Return the minimum value of two relative scalars.
static FloatEnergy	min(FloatEnergy r1, FloatEnergy r2, FloatEnergy... rn) Return the minimum value of more than two relative scalars.
FloatPower	multiplyBy(FloatFrequency v) Calculate the multiplication of FloatEnergy and FloatFrequency, which results in a FloatPower scalar.
FloatForce	multiplyBy(FloatLinearDensity v) Calculate the multiplication of FloatEnergy and FloatLinearDensity, which results in a FloatForce scalar.
FloatMoney	multiplyBy(FloatMoneyPerEnergy v) Calculate the multiplication of FloatEnergy and FloatMoneyPerEnergy, which results in a FloatMoney scalar.
static FloatEnergy	valueOf(String text) Returns a FloatEnergy 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 FloatEnergy ZERO

constant with value zero.

NaN

public static final FloatEnergy NaN

constant with value NaN.

POSITIVE_INFINITY

public static final FloatEnergy POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatEnergy NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatEnergy POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatEnergy NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

FloatEnergy

public FloatEnergy(float value,
                   EnergyUnit unit)

Construct FloatEnergy scalar.

Parameters:

value - float value

unit - unit for the float value

FloatEnergy

public FloatEnergy(FloatEnergy value)

Construct FloatEnergy scalar.

Parameters:

value - Scalar from which to construct this instance

FloatEnergy

public FloatEnergy(double value,
                   EnergyUnit unit)

Construct FloatEnergy scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

Method Detail

instantiateRel

public final FloatEnergy instantiateRel(float value,
                                        EnergyUnit unit)

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

Specified by:

instantiateRel in class AbstractFloatScalarRel<EnergyUnit,FloatEnergy>

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 FloatEnergy createSI(float value)

Construct FloatEnergy scalar.

Parameters:

value - float value in SI units

Returns:

the new scalar with the SI value

interpolate

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

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

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(FloatEnergy v)

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

Parameters:

v - FloatEnergy scalar

Returns:

FloatDimensionless scalar as a division of FloatEnergy and FloatEnergy

divideBy

public final FloatLength divideBy(FloatForce v)

Calculate the division of FloatEnergy and FloatForce, which results in a FloatLength scalar.

Parameters:

v - FloatEnergy scalar

Returns:

FloatLength scalar as a division of FloatEnergy and FloatForce

divideBy

public final FloatForce divideBy(FloatLength v)

Calculate the division of FloatEnergy and FloatLength, which results in a FloatForce scalar.

Parameters:

v - FloatEnergy scalar

Returns:

FloatForce scalar as a division of FloatEnergy and FloatLength

multiplyBy

public final FloatForce multiplyBy(FloatLinearDensity v)

Calculate the multiplication of FloatEnergy and FloatLinearDensity, which results in a FloatForce scalar.

Parameters:

v - FloatEnergy scalar

Returns:

FloatForce scalar as a multiplication of FloatEnergy and FloatLinearDensity

divideBy

public final FloatPower divideBy(FloatDuration v)

Calculate the division of FloatEnergy and FloatDuration, which results in a FloatPower scalar.

Parameters:

v - FloatEnergy scalar

Returns:

FloatPower scalar as a division of FloatEnergy and FloatDuration

divideBy

public final FloatDuration divideBy(FloatPower v)

Calculate the division of FloatEnergy and FloatPower, which results in a FloatDuration scalar.

Parameters:

v - FloatEnergy scalar

Returns:

FloatDuration scalar as a division of FloatEnergy and FloatPower

divideBy

public final FloatPressure divideBy(FloatVolume v)

Calculate the division of FloatEnergy and FloatVolume, which results in a FloatPressure scalar.

Parameters:

v - FloatEnergy scalar

Returns:

FloatPressure scalar as a division of FloatEnergy and FloatVolume

multiplyBy

public final FloatPower multiplyBy(FloatFrequency v)

Calculate the multiplication of FloatEnergy and FloatFrequency, which results in a FloatPower scalar.

Parameters:

v - FloatEnergy scalar

Returns:

FloatPower scalar as a multiplication of FloatEnergy and FloatFrequency

multiplyBy

public final FloatMoney multiplyBy(FloatMoneyPerEnergy v)

Calculate the multiplication of FloatEnergy and FloatMoneyPerEnergy, which results in a FloatMoney scalar.

Parameters:

v - FloatEnergy scalar

Returns:

FloatMoney scalar as a multiplication of FloatEnergy and FloatMoneyPerEnergy