org.djunits.value.vfloat.scalar

Class FloatElectricalPotential

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<ElectricalPotentialUnit,FloatElectricalPotential>

org.djunits.value.vfloat.scalar.FloatElectricalPotential

All Implemented Interfaces:

Serializable, Comparable<FloatElectricalPotential>, MathFunctionsAbs<FloatElectricalPotential>, MathFunctionsRel<FloatElectricalPotential>, Relative, Value<ElectricalPotentialUnit>, FloatMathFunctions<FloatElectricalPotential>, FloatScalarInterface

public class FloatElectricalPotential
extends AbstractFloatScalarRel<ElectricalPotentialUnit,FloatElectricalPotential>

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

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

we can now write:

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

Method Summary

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

constant with value zero.

NaN

public static final FloatElectricalPotential NaN

constant with value NaN.

POSITIVE_INFINITY

public static final FloatElectricalPotential POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatElectricalPotential NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatElectricalPotential POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatElectricalPotential NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

FloatElectricalPotential

public FloatElectricalPotential(float value,
                                ElectricalPotentialUnit unit)

Construct FloatElectricalPotential scalar.

Parameters:

value - float value

unit - unit for the float value

FloatElectricalPotential

public FloatElectricalPotential(FloatElectricalPotential value)

Construct FloatElectricalPotential scalar.

Parameters:

value - Scalar from which to construct this instance

FloatElectricalPotential

public FloatElectricalPotential(double value,
                                ElectricalPotentialUnit unit)

Construct FloatElectricalPotential scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

Method Detail

instantiateRel

public final FloatElectricalPotential instantiateRel(float value,
                                                     ElectricalPotentialUnit unit)

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

Specified by:

instantiateRel in class AbstractFloatScalarRel<ElectricalPotentialUnit,FloatElectricalPotential>

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

Construct FloatElectricalPotential scalar.

Parameters:

value - float value in SI units

Returns:

the new scalar with the SI value

interpolate

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

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

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

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

Parameters:

v - FloatElectricalPotential scalar

Returns:

FloatDimensionless scalar as a division of FloatElectricalPotential and FloatElectricalPotential

multiplyBy

public final FloatPower multiplyBy(FloatElectricalCurrent v)

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

Parameters:

v - FloatElectricalPotential scalar

Returns:

FloatPower scalar as a multiplication of FloatElectricalPotential and FloatElectricalCurrent

divideBy

public final FloatElectricalResistance divideBy(FloatElectricalCurrent v)

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

Parameters:

v - FloatElectricalPotential scalar

Returns:

FloatElectricalResistance scalar as a division of FloatElectricalPotential and FloatElectricalCurrent

divideBy

public final FloatElectricalCurrent divideBy(FloatElectricalResistance v)

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

Parameters:

v - FloatElectricalPotential scalar

Returns:

FloatElectricalCurrent scalar as a division of FloatElectricalPotential and FloatElectricalResistance