org.djunits.value.vdouble.scalar

Class Frequency

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vdouble.scalar.AbstractDoubleScalar<U,R>

org.djunits.value.vdouble.scalar.AbstractDoubleScalarRel<FrequencyUnit,Frequency>

org.djunits.value.vdouble.scalar.Frequency

All Implemented Interfaces:

Serializable, Comparable<Frequency>, MathFunctionsAbs<Frequency>, MathFunctionsRel<Frequency>, Relative, Value<FrequencyUnit>, DoubleMathFunctions<Frequency>, DoubleScalarInterface

public class Frequency
extends AbstractDoubleScalarRel<FrequencyUnit,Frequency>

Easy access methods for the Frequency DoubleScalar, which is relative by definition. Instead of:

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

we can now write:

 Frequency value = new Frequency(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 Frequency	NaN constant with value NaN.
static Frequency	NEG_MAXVALUE constant with value -MAX_VALUE.
static Frequency	NEGATIVE_INFINITY constant with value NEGATIVE_INFINITY.
static Frequency	POS_MAXVALUE constant with value MAX_VALUE.
static Frequency	POSITIVE_INFINITY constant with value POSITIVE_INFINITY.
static Frequency	ZERO constant with value zero.

Fields inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalar

si

Fields inherited from class org.djunits.value.Scalar

NUMBER_PATTERN

Fields inherited from interface org.djunits.value.vdouble.DoubleMathFunctions

ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, NEG, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH

Constructor Summary

Constructors

Constructor and Description
Frequency(double value, FrequencyUnit unit) Construct Frequency scalar.
Frequency(Frequency value) Construct Frequency scalar.

Method Summary

Modifier and Type	Method and Description
static Frequency	createSI(double value) Construct Frequency scalar.
Dimensionless	divideBy(Frequency v) Calculate the division of Frequency and Frequency, which results in a Dimensionless scalar.
Frequency	instantiateRel(double value, FrequencyUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.
static Frequency	interpolate(Frequency zero, Frequency one, double ratio) Interpolate between two values.
static Frequency	max(Frequency r1, Frequency r2) Return the maximum value of two relative scalars.
static Frequency	max(Frequency r1, Frequency r2, Frequency... rn) Return the maximum value of more than two relative scalars.
static Frequency	min(Frequency r1, Frequency r2) Return the minimum value of two relative scalars.
static Frequency	min(Frequency r1, Frequency r2, Frequency... rn) Return the minimum value of more than two relative scalars.
Dimensionless	multiplyBy(Duration v) Calculate the multiplication of Frequency and Duration, which results in a Dimensionless scalar.
Power	multiplyBy(Energy v) Calculate the multiplication of Frequency and Energy, which results in a Power scalar.
Speed	multiplyBy(Length v) Calculate the multiplication of Frequency and Length, which results in a Speed scalar.
MoneyPerDuration	multiplyBy(Money v) Calculate the multiplication of Frequency and Money, which results in a MoneyPerDuration scalar.
Acceleration	multiplyBy(Speed v) Calculate the multiplication of Frequency and Speed, which results in a Acceleration scalar.
static Frequency	valueOf(String text) Returns a Frequency representation of a textual representation of a value with a unit.

Methods inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalarRel

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

Methods inherited from class org.djunits.value.vdouble.scalar.AbstractDoubleScalar

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.vdouble.DoubleMathFunctions

DIV, MULT, POW

Field Detail

ZERO

public static final Frequency ZERO

constant with value zero.

NaN

public static final Frequency NaN

constant with value NaN.

POSITIVE_INFINITY

public static final Frequency POSITIVE_INFINITY

constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final Frequency NEGATIVE_INFINITY

constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final Frequency POS_MAXVALUE

constant with value MAX_VALUE.

NEG_MAXVALUE

public static final Frequency NEG_MAXVALUE

constant with value -MAX_VALUE.

Constructor Detail

Frequency

public Frequency(double value,
                 FrequencyUnit unit)

Construct Frequency scalar.

Parameters:

value - double value

unit - unit for the double value

Frequency

public Frequency(Frequency value)

Construct Frequency scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateRel

public final Frequency instantiateRel(double value,
                                      FrequencyUnit unit)

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

Specified by:

instantiateRel in class AbstractDoubleScalarRel<FrequencyUnit,Frequency>

Parameters:

value - double; the double value

unit - U; the unit

Returns:

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

createSI

public static final Frequency createSI(double value)

Construct Frequency scalar.

Parameters:

value - double value in SI units

Returns:

the new scalar with the SI value

interpolate

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

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

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 Dimensionless divideBy(Frequency v)

Calculate the division of Frequency and Frequency, which results in a Dimensionless scalar.

Parameters:

v - Frequency scalar

Returns:

Dimensionless scalar as a division of Frequency and Frequency

multiplyBy

public final Dimensionless multiplyBy(Duration v)

Calculate the multiplication of Frequency and Duration, which results in a Dimensionless scalar.

Parameters:

v - Frequency scalar

Returns:

Dimensionless scalar as a multiplication of Frequency and Duration

multiplyBy

public final Speed multiplyBy(Length v)

Calculate the multiplication of Frequency and Length, which results in a Speed scalar.

Parameters:

v - Frequency scalar

Returns:

Speed scalar as a multiplication of Frequency and Length

multiplyBy

public final Acceleration multiplyBy(Speed v)

Calculate the multiplication of Frequency and Speed, which results in a Acceleration scalar.

Parameters:

v - Frequency scalar

Returns:

Acceleration scalar as a multiplication of Frequency and Speed

multiplyBy

public final Power multiplyBy(Energy v)

Calculate the multiplication of Frequency and Energy, which results in a Power scalar.

Parameters:

v - Frequency scalar

Returns:

Power scalar as a multiplication of Frequency and Energy

multiplyBy

public final MoneyPerDuration multiplyBy(Money v)

Calculate the multiplication of Frequency and Money, which results in a MoneyPerDuration scalar.

Parameters:

v - Frequency scalar

Returns:

MoneyPerDuration scalar as a multiplication of Frequency and Money