org.djunits.value.vdouble.scalar

Class Power

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

org.djunits.value.vdouble.scalar.Power

All Implemented Interfaces:

Serializable, Comparable<Power>, MathFunctionsAbs<Power>, MathFunctionsRel<Power>, Relative, Value<PowerUnit>, DoubleMathFunctions<Power>, DoubleScalarInterface

public class Power
extends AbstractDoubleScalarRel<PowerUnit,Power>

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

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

we can now write:

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

Method Summary

Modifier and Type	Method and Description
static Power	createSI(double value) Construct Power scalar.
ElectricalPotential	divideBy(ElectricalCurrent v) Calculate the division of Power and ElectricalCurrent, which results in a ElectricalPotential scalar.
ElectricalCurrent	divideBy(ElectricalPotential v) Calculate the division of Power and ElectricalPotential, which results in a ElectricalCurrent scalar.
Frequency	divideBy(Energy v) Calculate the division of Power and Energy, which results in a Frequency scalar.
Speed	divideBy(Force v) Calculate the division of Power and Force, which results in a Speed scalar.
Energy	divideBy(Frequency v) Calculate the division of Power and Frequency, which results in a Energy scalar.
Dimensionless	divideBy(Power v) Calculate the division of Power and Power, which results in a Dimensionless scalar.
Force	divideBy(Speed v) Calculate the division of Power and Speed, which results in a Force scalar.
Power	instantiateRel(double value, PowerUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
static Power	interpolate(Power zero, Power one, double ratio) Interpolate between two values.
static Power	max(Power r1, Power r2) Return the maximum value of two relative scalars.
static Power	max(Power r1, Power r2, Power... rn) Return the maximum value of more than two relative scalars.
static Power	min(Power r1, Power r2) Return the minimum value of two relative scalars.
static Power	min(Power r1, Power r2, Power... rn) Return the minimum value of more than two relative scalars.
Energy	multiplyBy(Duration v) Calculate the multiplication of Power and Duration, which results in a Energy scalar.
static Power	valueOf(String text) Returns a Power 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 Power ZERO

constant with value zero.

NaN

public static final Power NaN

constant with value NaN.

POSITIVE_INFINITY

public static final Power POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final Power NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final Power POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final Power NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

Power

public Power(double value,
             PowerUnit unit)

Construct Power scalar.

Parameters:

value - double value

unit - unit for the double value

Power

public Power(Power value)

Construct Power scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateRel

public final Power instantiateRel(double value,
                                  PowerUnit unit)

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

Specified by:

instantiateRel in class AbstractDoubleScalarRel<PowerUnit,Power>

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 Power createSI(double value)

Construct Power scalar.

Parameters:

value - double value in SI units

Returns:

the new scalar with the SI value

interpolate

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

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

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

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

Parameters:

v - Power scalar

Returns:

Dimensionless scalar as a division of Power and Power

multiplyBy

public final Energy multiplyBy(Duration v)

Calculate the multiplication of Power and Duration, which results in a Energy scalar.

Parameters:

v - Power scalar

Returns:

Energy scalar as a multiplication of Power and Duration

divideBy

public final Energy divideBy(Frequency v)

Calculate the division of Power and Frequency, which results in a Energy scalar.

Parameters:

v - Power scalar

Returns:

Energy scalar as a division of Power and Frequency

divideBy

public final Frequency divideBy(Energy v)

Calculate the division of Power and Energy, which results in a Frequency scalar.

Parameters:

v - Power scalar

Returns:

Frequency scalar as a division of Power and Energy

divideBy

public final Force divideBy(Speed v)

Calculate the division of Power and Speed, which results in a Force scalar.

Parameters:

v - Power scalar

Returns:

Force scalar as a division of Power and Speed

divideBy

public final Speed divideBy(Force v)

Calculate the division of Power and Force, which results in a Speed scalar.

Parameters:

v - Power scalar

Returns:

Speed scalar as a division of Power and Force

divideBy

public final ElectricalCurrent divideBy(ElectricalPotential v)

Calculate the division of Power and ElectricalPotential, which results in a ElectricalCurrent scalar.

Parameters:

v - Power scalar

Returns:

ElectricalCurrent scalar as a division of Power and ElectricalPotential

divideBy

public final ElectricalPotential divideBy(ElectricalCurrent v)

Calculate the division of Power and ElectricalCurrent, which results in a ElectricalPotential scalar.

Parameters:

v - Power scalar

Returns:

ElectricalPotential scalar as a division of Power and ElectricalCurrent