Package org.djunits.value.vfloat.scalar

Class FloatPower

java.lang.Object

java.lang.Number

org.djunits.value.AbstractScalar<U,S>

org.djunits.value.vfloat.scalar.base.AbstractFloatScalar<U,R>

org.djunits.value.vfloat.scalar.base.AbstractFloatScalarRel<PowerUnit,FloatPower>

org.djunits.value.vfloat.scalar.FloatPower

All Implemented Interfaces:

Serializable, Cloneable, Comparable<FloatPower>, Scalar<PowerUnit,FloatPower>, Scalar.Rel<PowerUnit,FloatPower>, ValueFunctions<PowerUnit,FloatPower>, Relative<PowerUnit,FloatPower>, Value<PowerUnit,FloatPower>, FloatScalarInterface<PowerUnit,FloatPower>, FloatScalarInterface.Rel<PowerUnit,FloatPower>

@Generated(value="org.djunits.generator.GenerateDJUNIT",
           date="2023-04-30T13:59:27.633664900Z")
public class FloatPower
extends AbstractFloatScalarRel<PowerUnit,FloatPower>

Easy access methods for the FloatPower FloatScalar, which is relative by definition.

Copyright (c) 2013-2023 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

Nested Class Summary

Nested classes/interfaces inherited from interface org.djunits.value.vfloat.scalar.base.FloatScalarInterface

FloatScalarInterface.Abs<AU extends AbsoluteLinearUnit<AU,RU>,A extends FloatScalarInterface.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends FloatScalarInterface.RelWithAbs<AU,A,RU,R>>, FloatScalarInterface.Rel<U extends Unit<U>,R extends FloatScalarInterface.Rel<U,R>>, FloatScalarInterface.RelWithAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends FloatScalarInterface.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends FloatScalarInterface.RelWithAbs<AU,A,RU,R>>

Nested classes/interfaces inherited from interface org.djunits.value.base.Scalar

Scalar.Abs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends Scalar.RelWithAbs<AU,A,RU,R>>, Scalar.Rel<U extends Unit<U>,R extends Scalar.Rel<U,R>>, Scalar.RelWithAbs<AU extends AbsoluteLinearUnit<AU,RU>,A extends Scalar.Abs<AU,A,RU,R>,RU extends Unit<RU>,R extends Scalar.RelWithAbs<AU,A,RU,R>>

Field Summary

Fields

Modifier and Type	Field	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	ONE	Constant with value one.
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.base.AbstractFloatScalar

si

Constructor Summary

Constructors

Constructor	Description
FloatPower(double value, PowerUnit unit)	Construct FloatPower scalar using a double value.
FloatPower(float value, PowerUnit unit)	Construct FloatPower scalar.
FloatPower(FloatPower value)	Construct FloatPower scalar.

Method Summary

Modifier and Type	Method	Description
FloatMomentum	divide(FloatAcceleration v)	Calculate the division of FloatPower and FloatAcceleration, which results in a FloatMomentum scalar.
FloatElectricalPotential	divide(FloatElectricalCurrent v)	Calculate the division of FloatPower and FloatElectricalCurrent, which results in a FloatElectricalPotential scalar.
FloatElectricalCurrent	divide(FloatElectricalPotential v)	Calculate the division of FloatPower and FloatElectricalPotential, which results in a FloatElectricalCurrent scalar.
FloatFrequency	divide(FloatEnergy v)	Calculate the division of FloatPower and FloatEnergy, which results in a FloatFrequency scalar.
FloatSpeed	divide(FloatForce v)	Calculate the division of FloatPower and FloatForce, which results in a FloatSpeed scalar.
FloatEnergy	divide(FloatFrequency v)	Calculate the division of FloatPower and FloatFrequency, which results in a FloatEnergy scalar.
FloatAcceleration	divide(FloatMomentum v)	Calculate the division of FloatPower and FloatMomentum, which results in a FloatAcceleration scalar.
FloatDimensionless	divide(FloatPower v)	Calculate the division of FloatPower and FloatPower, which results in a FloatDimensionless scalar.
FloatForce	divide(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	instantiateSI(float value)	Construct FloatPower scalar.
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.
static FloatPower	of(float value, String unitString)	Returns a FloatPower based on a value and the textual representation of the unit, which can be localized.
FloatSIScalar	reciprocal()	Create the reciprocal of this scalar with the correct dimensions.
FloatEnergy	times(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.base.AbstractFloatScalarRel

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

Methods inherited from class org.djunits.value.vfloat.scalar.base.AbstractFloatScalar

compareTo, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, intValue, le, le0, longValue, lt, lt0, ne, ne0, toDisplayString, toDisplayString, toString, toString, toString, toString, toStringSIPrefixed, toStringSIPrefixed, toTextualString, toTextualString

Methods inherited from class org.djunits.value.AbstractScalar

getDisplayUnit, 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 java.lang.Comparable

compareTo

Methods inherited from interface org.djunits.value.vfloat.scalar.base.FloatScalarInterface

getInUnit, getInUnit, getSI

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

eq, eq0, format, format, ge, ge0, gt, gt0, le, le0, lt, lt0, ne, ne0, toDisplayString, toDisplayString, toTextualString, toTextualString

Methods inherited from interface org.djunits.value.Value

getDisplayUnit, isAbsolute, isRelative, setDisplayUnit, toString, toString, toString, toString

Field Detail

ZERO

public static final FloatPower ZERO

Constant with value zero.

ONE

public static final FloatPower ONE

Constant with value one.

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; the 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; the 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.

Parameters:

value - float; the float value

unit - U; the unit

Returns:

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

instantiateSI

public static final FloatPower instantiateSI(float value)

Construct FloatPower scalar.

Parameters:

value - float; the 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 - double; 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)

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

Returns:

FloatPower; 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 FloatPower of(float value,
                            String unitString)

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

FloatPower; 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 FloatDimensionless divide(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

times

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

divide

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

divide

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

divide

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

divide

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

divide

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

divide

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

divide

public final FloatMomentum divide(FloatAcceleration v)

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

Parameters:

v - FloatPower; scalar

Returns:

FloatMomentum; scalar as a division of FloatPower and FloatAcceleration

divide

public final FloatAcceleration divide(FloatMomentum v)

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

Parameters:

v - FloatPower; scalar

Returns:

FloatAcceleration; scalar as a division of FloatPower and FloatMomentum

reciprocal

public FloatSIScalar reciprocal()

Create the reciprocal of this scalar with the correct dimensions.

Specified by:

reciprocal in class AbstractFloatScalarRel<PowerUnit,FloatPower>

Returns:

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