org.djunits.value.vfloat.scalar

Class FloatFrequency

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vfloat.scalar.FloatScalar<U>

org.djunits.value.vfloat.scalar.FloatScalar.Rel<U>

org.djunits.value.vfloat.scalar.TypedFloatScalarRel<FrequencyUnit,FloatFrequency>

org.djunits.value.vfloat.scalar.FloatFrequency

All Implemented Interfaces:

Serializable, Comparable<FloatScalar.Rel<FrequencyUnit>>, MathFunctionsAbs<FloatScalar.Rel<FrequencyUnit>>, MathFunctionsRel<FloatScalar.Rel<FrequencyUnit>>, Relative, Value<FrequencyUnit>, FloatMathFunctions<FloatScalar<FrequencyUnit>>

public class FloatFrequency
extends TypedFloatScalarRel<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-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

$LastChangedDate: 2016-05-28 14:25:52 +0200 (Sat, 28 May 2016) $, @version $Revision: 202 $, by $Author: averbraeck $, initial version Sep 5, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.djunits.value.vfloat.scalar.FloatScalar

FloatScalar.Abs<U extends Unit<U>>, FloatScalar.Rel<U extends Unit<U>>

Field Summary

Fields

Modifier and Type	Field and Description
static FloatFrequency	ZERO constant with value zero.

Fields inherited from class org.djunits.value.vfloat.scalar.FloatScalar.Rel

si

Fields inherited from interface org.djunits.value.vfloat.FloatMathFunctions

ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, 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
FloatDimensionless	divideBy(FloatFrequency v) Calculate the division of FloatFrequency and FloatFrequency, which results in a FloatDimensionless scalar.
protected FloatFrequency	instantiateTypeRel(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.
FloatMoneyPerTime	multiplyBy(FloatMoney v) Calculate the multiplication of FloatFrequency and FloatMoney, which results in a FloatMoneyPerTime scalar.
FloatAcceleration	multiplyBy(FloatSpeed v) Calculate the multiplication of FloatFrequency and FloatSpeed, which results in a FloatAcceleration scalar.

Methods inherited from class org.djunits.value.vfloat.scalar.TypedFloatScalarRel

abs, ceil, divideBy, floor, minus, multiplyBy, plus, rint, round

Methods inherited from class org.djunits.value.vfloat.scalar.FloatScalar.Rel

compareTo, eq, ge, getSI, gt, le, lt, minus, ne, plus

Methods inherited from class org.djunits.value.vfloat.scalar.FloatScalar

divide, divide, doubleValue, equals, floatValue, getInUnit, getInUnit, hashCode, interpolate, interpolate, intValue, longValue, minus, minus, minus, multiply, multiply, plus, plus, plus, toString, toString, toString, toString

Methods inherited from class org.djunits.value.Scalar

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative

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.

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

instantiateTypeRel

protected final FloatFrequency instantiateTypeRel(float value,
                                                  FrequencyUnit unit)

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

Specified by:

instantiateTypeRel in class TypedFloatScalarRel<FrequencyUnit,FloatFrequency>

Parameters:

value - the float value

unit - the unit

Returns:

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

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

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 FloatMoneyPerTime multiplyBy(FloatMoney v)

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

Parameters:

v - FloatFrequency scalar

Returns:

FloatMoneyPerTime scalar as a multiplication of FloatFrequency and FloatMoney