org.djunits.value.vfloat.scalar

Class FloatPower

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<PowerUnit,FloatPower>

org.djunits.value.vfloat.scalar.FloatPower

All Implemented Interfaces:

Serializable, Comparable<FloatPower>, MathFunctionsAbs<FloatPower>, MathFunctionsRel<FloatPower>, Relative, Value<PowerUnit>, FloatMathFunctions<FloatPower>, FloatScalarInterface

public class FloatPower
extends AbstractFloatScalarRel<PowerUnit,FloatPower>

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

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

we can now write:

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

Method Summary

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

constant with value zero.

NaN

public static final FloatPower NaN

constant with value NaN.

POSITIVE_INFINITY

public static final FloatPower POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatPower NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatPower POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatPower NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

FloatPower

public FloatPower(float value,
                  PowerUnit unit)

Construct FloatPower scalar.

Parameters:

value - float value

unit - unit for the float value

FloatPower

public FloatPower(FloatPower value)

Construct FloatPower scalar.

Parameters:

value - Scalar from which to construct this instance

FloatPower

public FloatPower(double value,
                  PowerUnit unit)

Construct FloatPower scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

Method Detail

instantiateRel

public final FloatPower instantiateRel(float value,
                                       PowerUnit unit)

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

Specified by:

instantiateRel in class AbstractFloatScalarRel<PowerUnit,FloatPower>

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

Construct FloatPower scalar.

Parameters:

value - float value in SI units

Returns:

the new scalar with the SI value

interpolate

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

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

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

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

Parameters:

v - FloatPower scalar

Returns:

FloatDimensionless scalar as a division of FloatPower and FloatPower

multiplyBy

public final FloatEnergy multiplyBy(FloatDuration v)

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

Parameters:

v - FloatPower scalar

Returns:

FloatEnergy scalar as a multiplication of FloatPower and FloatDuration

divideBy

public final FloatEnergy divideBy(FloatFrequency v)

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

Parameters:

v - FloatPower scalar

Returns:

FloatEnergy scalar as a division of FloatPower and FloatFrequency

divideBy

public final FloatFrequency divideBy(FloatEnergy v)

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

Parameters:

v - FloatPower scalar

Returns:

FloatFrequency scalar as a division of FloatPower and FloatEnergy

divideBy

public final FloatForce divideBy(FloatSpeed v)

Calculate the division of FloatPower and FloatSpeed, which results in a FloatForce scalar.

Parameters:

v - FloatPower scalar

Returns:

FloatForce scalar as a division of FloatPower and FloatSpeed

divideBy

public final FloatSpeed divideBy(FloatForce v)

Calculate the division of FloatPower and FloatForce, which results in a FloatSpeed scalar.

Parameters:

v - FloatPower scalar

Returns:

FloatSpeed scalar as a division of FloatPower and FloatForce

divideBy

public final FloatElectricalCurrent divideBy(FloatElectricalPotential v)

Calculate the division of FloatPower and FloatElectricalPotential, which results in a FloatElectricalCurrent scalar.

Parameters:

v - FloatPower scalar

Returns:

FloatElectricalCurrent scalar as a division of FloatPower and FloatElectricalPotential

divideBy

public final FloatElectricalPotential divideBy(FloatElectricalCurrent v)

Calculate the division of FloatPower and FloatElectricalCurrent, which results in a FloatElectricalPotential scalar.

Parameters:

v - FloatPower scalar

Returns:

FloatElectricalPotential scalar as a division of FloatPower and FloatElectricalCurrent