org.djunits.value.vfloat.scalar

Class FloatElectricalResistance

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<ElectricalResistanceUnit,FloatElectricalResistance>

org.djunits.value.vfloat.scalar.FloatElectricalResistance

All Implemented Interfaces:

Serializable, Comparable<FloatElectricalResistance>, MathFunctionsAbs<FloatElectricalResistance>, MathFunctionsRel<FloatElectricalResistance>, Relative, Value<ElectricalResistanceUnit>, FloatMathFunctions<FloatElectricalResistance>, FloatScalarInterface

public class FloatElectricalResistance
extends AbstractFloatScalarRel<ElectricalResistanceUnit,FloatElectricalResistance>

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

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

we can now write:

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

Method Summary

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

constant with value zero.

NaN

public static final FloatElectricalResistance NaN

constant with value NaN.

POSITIVE_INFINITY

public static final FloatElectricalResistance POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatElectricalResistance NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatElectricalResistance POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatElectricalResistance NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

FloatElectricalResistance

public FloatElectricalResistance(float value,
                                 ElectricalResistanceUnit unit)

Construct FloatElectricalResistance scalar.

Parameters:

value - float value

unit - unit for the float value

FloatElectricalResistance

public FloatElectricalResistance(FloatElectricalResistance value)

Construct FloatElectricalResistance scalar.

Parameters:

value - Scalar from which to construct this instance

FloatElectricalResistance

public FloatElectricalResistance(double value,
                                 ElectricalResistanceUnit unit)

Construct FloatElectricalResistance scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

Method Detail

instantiateRel

public final FloatElectricalResistance instantiateRel(float value,
                                                      ElectricalResistanceUnit unit)

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

Specified by:

instantiateRel in class AbstractFloatScalarRel<ElectricalResistanceUnit,FloatElectricalResistance>

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

Construct FloatElectricalResistance scalar.

Parameters:

value - float value in SI units

Returns:

the new scalar with the SI value

interpolate

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

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

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

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

Parameters:

v - FloatElectricalResistance scalar

Returns:

FloatDimensionless scalar as a division of FloatElectricalResistance and FloatElectricalResistance

multiplyBy

public final FloatElectricalPotential multiplyBy(FloatElectricalCurrent v)

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

Parameters:

v - FloatElectricalResistance scalar

Returns:

FloatElectricalPotential scalar as a multiplication of FloatElectricalResistance and FloatElectricalCurrent