org.djunits.value.vfloat.scalar

Class FloatFrequency

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<FrequencyUnit,FloatFrequency>

org.djunits.value.vfloat.scalar.FloatFrequency

All Implemented Interfaces:

Serializable, Comparable<FloatFrequency>, MathFunctionsAbs<FloatFrequency>, MathFunctionsRel<FloatFrequency>, Relative, Value<FrequencyUnit>, FloatMathFunctions<FloatFrequency>, FloatScalarInterface

public class FloatFrequency
extends AbstractFloatScalarRel<FrequencyUnit,FloatFrequency>

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

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

we can now write:

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

Method Summary

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

constant with value zero.

NaN

public static final FloatFrequency NaN

constant with value NaN.

POSITIVE_INFINITY

public static final FloatFrequency POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final FloatFrequency NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final FloatFrequency POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final FloatFrequency NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

FloatFrequency

public FloatFrequency(float value,
                      FrequencyUnit unit)

Construct FloatFrequency scalar.

Parameters:

value - float value

unit - unit for the float value

FloatFrequency

public FloatFrequency(FloatFrequency value)

Construct FloatFrequency scalar.

Parameters:

value - Scalar from which to construct this instance

FloatFrequency

public FloatFrequency(double value,
                      FrequencyUnit unit)

Construct FloatFrequency scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

Method Detail

instantiateRel

public final FloatFrequency instantiateRel(float value,
                                           FrequencyUnit unit)

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

Specified by:

instantiateRel in class AbstractFloatScalarRel<FrequencyUnit,FloatFrequency>

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

Construct FloatFrequency scalar.

Parameters:

value - float value in SI units

Returns:

the new scalar with the SI value

interpolate

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

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

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

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

Parameters:

v - FloatFrequency scalar

Returns:

FloatDimensionless scalar as a division of FloatFrequency and FloatFrequency

multiplyBy

public final FloatDimensionless multiplyBy(FloatDuration v)

Calculate the multiplication of FloatFrequency and FloatDuration, which results in a FloatDimensionless scalar.

Parameters:

v - FloatFrequency scalar

Returns:

FloatDimensionless scalar as a multiplication of FloatFrequency and FloatDuration

multiplyBy

public final FloatSpeed multiplyBy(FloatLength v)

Calculate the multiplication of FloatFrequency and FloatLength, which results in a FloatSpeed scalar.

Parameters:

v - FloatFrequency scalar

Returns:

FloatSpeed scalar as a multiplication of FloatFrequency and FloatLength

multiplyBy

public final FloatAcceleration multiplyBy(FloatSpeed v)

Calculate the multiplication of FloatFrequency and FloatSpeed, which results in a FloatAcceleration scalar.

Parameters:

v - FloatFrequency scalar

Returns:

FloatAcceleration scalar as a multiplication of FloatFrequency and FloatSpeed

multiplyBy

public final FloatPower multiplyBy(FloatEnergy v)

Calculate the multiplication of FloatFrequency and FloatEnergy, which results in a FloatPower scalar.

Parameters:

v - FloatFrequency scalar

Returns:

FloatPower scalar as a multiplication of FloatFrequency and FloatEnergy

multiplyBy

public final FloatMoneyPerDuration multiplyBy(FloatMoney v)

Calculate the multiplication of FloatFrequency and FloatMoney, which results in a FloatMoneyPerDuration scalar.

Parameters:

v - FloatFrequency scalar

Returns:

FloatMoneyPerDuration scalar as a multiplication of FloatFrequency and FloatMoney