Package org.djunits.value.vdouble.scalar

Class Power

java.lang.Object

java.lang.Number

org.djunits.value.base.Scalar<U,S>

org.djunits.value.vdouble.scalar.base.DoubleScalar<U,R>

org.djunits.value.vdouble.scalar.base.DoubleScalarRel<PowerUnit,Power>

org.djunits.value.vdouble.scalar.Power

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Power>, Relative<PowerUnit,Power>, Value<PowerUnit,Power>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-07-23T14:06:38.224104100Z")
public class Power
extends DoubleScalarRel<PowerUnit,Power>

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

Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final Power	NaN	Constant with value NaN.
static final Power	NEG_MAXVALUE	Constant with value -MAX_VALUE.
static final Power	NEGATIVE_INFINITY	Constant with value NEGATIVE_INFINITY.
static final Power	ONE	Constant with value one.
static final Power	POS_MAXVALUE	Constant with value MAX_VALUE.
static final Power	POSITIVE_INFINITY	Constant with value POSITIVE_INFINITY.
static final Power	ZERO	Constant with value zero.

Fields inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar

si

Constructor Summary

Constructors

Constructor	Description
Power(double value, PowerUnit unit)	Construct Power scalar.
Power(Power value)	Construct Power scalar.

Method Summary

Modifier and Type	Method	Description
final Momentum	divide(Acceleration v)	Calculate the division of Power and Acceleration, which results in a Momentum scalar.
final ElectricalPotential	divide(ElectricalCurrent v)	Calculate the division of Power and ElectricalCurrent, which results in a ElectricalPotential scalar.
final ElectricalCurrent	divide(ElectricalPotential v)	Calculate the division of Power and ElectricalPotential, which results in a ElectricalCurrent scalar.
final Frequency	divide(Energy v)	Calculate the division of Power and Energy, which results in a Frequency scalar.
final Speed	divide(Force v)	Calculate the division of Power and Force, which results in a Speed scalar.
final Energy	divide(Frequency v)	Calculate the division of Power and Frequency, which results in a Energy scalar.
final Acceleration	divide(Momentum v)	Calculate the division of Power and Momentum, which results in a Acceleration scalar.
final Dimensionless	divide(Power v)	Calculate the division of Power and Power, which results in a Dimensionless scalar.
final Force	divide(Speed v)	Calculate the division of Power and Speed, which results in a Force scalar.
final Power	instantiateRel(double value, PowerUnit unit)	Construct a new Relative Immutable DoubleScalar of the right type.
static final Power	instantiateSI(double value)	Construct Power scalar.
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.
static Power	of(double value, String unitString)	Returns a Power based on a value and the textual representation of the unit, which can be localized.
SIScalar	reciprocal()	Create the reciprocal of this scalar with the correct dimensions.
final Energy	times(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.base.DoubleScalarRel

abs, ceil, divide, divide, divide, floor, minus, neg, plus, rint, times, times, times

Methods inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar

compareTo, divide, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, instantiate, instantiateAnonymous, instantiateSI, interpolate, interpolate, intValue, le, le0, longValue, lt, lt0, max, max, min, min, minus, minus, minus, multiply, ne, ne0, plus, plus, plus, toDisplayString, toDisplayString, toString, toString, toString, toString, toStringSIPrefixed, toStringSIPrefixed, toTextualString, toTextualString

Methods inherited from class org.djunits.value.base.Scalar

format, format, getDisplayUnit, 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.Value

isAbsolute, isRelative

Field Details

ZERO

public static final Power ZERO

Constant with value zero.

ONE

public static final Power ONE

Constant with value one.

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 Details

Power

public Power(double value,
 PowerUnit unit)

Construct Power scalar.

Parameters:

value - double; the double value

unit - PowerUnit; unit for the double value

Power

public Power(Power value)

Construct Power scalar.

Parameters:

value - Power; Scalar from which to construct this instance

Method Details

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

instantiateSI

public static final Power instantiateSI(double value)

Construct Power scalar.

Parameters:

value - double; the double value in SI units

Returns:

Power; the new scalar with the SI value

interpolate

public static Power interpolate(Power zero,
 Power one,
 double ratio)

Interpolate between two values.

Parameters:

zero - Power; the low value

one - Power; the high value

ratio - double; the ratio between 0 and 1, inclusive

Returns:

Power; 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 - Power; the first scalar

r2 - Power; the second scalar

Returns:

Power; 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 - Power; the first scalar

r2 - Power; the second scalar

rn - Power...; the other scalars

Returns:

Power; 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 - Power; the first scalar

r2 - Power; the second scalar

Returns:

Power; 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 - Power; the first scalar

r2 - Power; the second scalar

rn - Power...; the other scalars

Returns:

Power; the minimum value of more than two relative scalars

valueOf

public static Power valueOf(String text)

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 a localized or English abbreviation of the unit. Spaces are allowed, but not required, between the value and the unit.

Parameters:

text - String; the textual representation to parse into a Power

Returns:

Power; the Scalar representation of the value in its unit

Throws:

IllegalArgumentException - when the text cannot be parsed

NullPointerException - when the text argument is null

of

public static Power of(double value,
 String unitString)

Returns a Power based on a value and the textual representation of the unit, which can be localized.

Parameters:

value - double; the value to use

unitString - String; the textual representation of the unit

Returns:

Power; the Scalar representation of the value in its unit

Throws:

IllegalArgumentException - when the unit cannot be parsed or is incorrect

NullPointerException - when the unitString argument is null

divide

public final Dimensionless divide(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

times

public final Energy times(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

divide

public final Energy divide(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

divide

public final Frequency divide(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

divide

public final Force divide(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

divide

public final Speed divide(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

divide

public final ElectricalCurrent divide(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

divide

public final ElectricalPotential divide(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

divide

public final Momentum divide(Acceleration v)

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

Parameters:

v - Power; scalar

Returns:

Momentum; scalar as a division of Power and Acceleration

divide

public final Acceleration divide(Momentum v)

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

Parameters:

v - Power; scalar

Returns:

Acceleration; scalar as a division of Power and Momentum

reciprocal

public SIScalar reciprocal()

Create the reciprocal of this scalar with the correct dimensions.

Specified by:

reciprocal in class DoubleScalarRel<PowerUnit,Power>

Returns:

DoubleScalar<?>; a new scalar instance with correct SI dimensions