org.djunits.value.vdouble.vector

Class MutableFrequencyVector

java.lang.Object

org.djunits.value.AbstractValue<U>

org.djunits.value.vdouble.vector.DoubleVector<U>

org.djunits.value.vdouble.vector.MutableDoubleVector<U>

org.djunits.value.vdouble.vector.MutableDoubleVector.Rel<FrequencyUnit>

org.djunits.value.vdouble.vector.MutableFrequencyVector

All Implemented Interfaces:

Serializable, FunctionsRel<FrequencyUnit,DoubleVector.Abs<FrequencyUnit>,DoubleVector.Rel<FrequencyUnit>>, MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>, Relative, Value<FrequencyUnit>, DoubleMathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>, DoubleVectorInterface<FrequencyUnit>, MutableDoubleVectorInterface<FrequencyUnit>

Direct Known Subclasses:

MutableFrequencyVector.Dense, MutableFrequencyVector.Sparse

public abstract class MutableFrequencyVector
extends MutableDoubleVector.Rel<FrequencyUnit>

Mutable Frequency Vector.

Copyright (c) 2013-2015 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

$LastChangedDate: 2015-09-29 14:14:28 +0200 (Tue, 29 Sep 2015) $, @version $Revision: 73 $, by $Author: pknoppers $, initial version Sep 5, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MutableFrequencyVector.Dense Double Dense Relative Immutable Frequency class.
static class	MutableFrequencyVector.Sparse Double Sparse Relative Immutable Frequency class.

Nested classes/interfaces inherited from class org.djunits.value.vdouble.vector.MutableDoubleVector

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

Field Summary

Fields inherited from class org.djunits.value.vdouble.vector.DoubleVector

data

Constructor Summary

Constructors

Constructor and Description
MutableFrequencyVector(FrequencyUnit unit)

Method Summary

Modifier and Type	Method and Description
MutableFrequencyVector	abs() Set the value(s) to their absolute value.
MutableFrequencyVector	acos() Set the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.
MutableFrequencyVector	asin() Set the value(s) to the arc sine of the value(s); the resulting angle is in the range -pi/2 through pi/2.
MutableFrequencyVector	atan() Set the value(s) to the arc tangent of the value(s); the resulting angle is in the range -pi/2 through pi/2.
MutableFrequencyVector	cbrt() Set the value(s) to the(ir) cube root.
MutableFrequencyVector	ceil() Set the value(s) to the smallest (closest to negative infinity) value(s) that are greater than or equal to the argument and equal to a mathematical integer.
MutableFrequencyVector	copy() Create a deep copy of this MutableDoubleVector.
MutableFrequencyVector	cos() Set the value(s) to the trigonometric cosine of the value(s).
MutableFrequencyVector	cosh() Set the value(s) to the hyperbolic cosine of the value(s).
FrequencyVector	divide(FrequencyVector rel) Divide this Relative value by a Relative value for a vector or matrix.
FrequencyVector	divide(MutableFrequencyVector rel) Divide this Relative value by a Relative value for a vector or matrix.
MutableFrequencyVector	divideBy(double constant) Scale the value(s) by the inverse of a factor; i.e.
MutableFrequencyVector	exp() Set the value(s) to Euler's number e raised to the power of the value(s).
MutableFrequencyVector	expm1() Set the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).
MutableFrequencyVector	floor() Set the value(s) to the largest (closest to positive infinity) value(s) that are less than or equal to the argument and equal to a mathematical integer.
Frequency	get(int index) Retrieve the value stored at a specified index as a DoubleScalar.
abstract FrequencyVector	immutable() Create a immutable version of this MutableDoubleVector.
MutableFrequencyVector	inv() Set the value(s) to the complement (1.0/x) of the value(s).
MutableFrequencyVector	log() Set the value(s) to the natural logarithm (base e) of the value(s).
MutableFrequencyVector	log10() Set the value(s) to the base 10 logarithm of the value(s).
MutableFrequencyVector	log1p() Set the value(s) to the natural logarithm of the sum of the value(s) and 1.
FrequencyVector	minus(FrequencyVector rel) Subtract a Relative value from this Relative value for a vector or matrix.
FrequencyVector	minus(MutableFrequencyVector rel) Subtract a Relative value from this Relative value for a vector or matrix.
MutableFrequencyVector	multiplyBy(double constant) Scale the value(s) by a factor.
abstract MutableFrequencyVector	mutable() Create a mutable version of this DoubleVector.
FrequencyVector	plus(FrequencyVector rel) Add a Relative value to this Relative value for a vector or matrix.
FrequencyVector	plus(MutableFrequencyVector rel) Add a Relative value to this Relative value for a vector or matrix.
MutableFrequencyVector	pow(double x) Set the value(s) to the value(s) raised to the power of the argument.
MutableFrequencyVector	rint() Set the value(s) to the value(s) that are closest in value to the argument and equal to a mathematical integer.
MutableFrequencyVector	round() Set the value(s) to the closest long to the argument with ties rounding up.
MutableFrequencyVector	signum() Set the value(s) to the signum function of the value(s); zero if the argument is zero, 1.0 if the argument is greater than zero, -1.0 if the argument is less than zero.
MutableFrequencyVector	sin() Set the value(s) to the trigonometric sine of the value(s).
MutableFrequencyVector	sinh() Set the value(s) to the hyperbolic sine of the value(s).
MutableFrequencyVector	sqrt() Set the value(s) to the correctly rounded positive square root of the value(s).
MutableFrequencyVector	tan() Set the value(s) to the trigonometric tangent of the value(s).
MutableFrequencyVector	tanh() Set the value(s) to the hyperbolic tangent of the value(s).
FrequencyVector	times(FrequencyVector rel) Multiply a Relative value with this Relative value for a vector or matrix.
FrequencyVector	times(MutableFrequencyVector rel) Multiply a Relative value with this Relative value for a vector or matrix.
MutableFrequencyVector	toDegrees() Set the value(s) to approximately equivalent angle(s) measured in degrees.
abstract MutableFrequencyVector	toDense() Create a dense version of this DoubleVector.
MutableFrequencyVector	toRadians() Set the value(s) to approximately equivalent angle(s) measured in radians.
abstract MutableFrequencyVector	toSparse() Create a sparse version of this DoubleVector.

Methods inherited from class org.djunits.value.vdouble.vector.MutableDoubleVector.Rel

decrementBy, divide, incrementBy, minus, plus, plus, times

Methods inherited from class org.djunits.value.vdouble.vector.MutableDoubleVector

assign, checkCopyOnWrite, decrementByImpl, incrementByImpl, normalize, scaleValueByValue, scaleValueByValue, set, setInUnit, setSI

Methods inherited from class org.djunits.value.vdouble.vector.DoubleVector

cardinality, checkIndex, checkSize, checkSize, equals, getData, getInUnit, getInUnit, getSI, getValuesInUnit, getValuesInUnit, getValuesSI, hashCode, initializeSparse, initializeSparseMA, initializeSparseMR, safeGet, safeSet, size, toString, toString, toString, toString, zSum

Methods inherited from class org.djunits.value.AbstractValue

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.djunits.value.vdouble.vector.DoubleVectorInterface

cardinality, getInUnit, getInUnit, getSI, getValuesInUnit, getValuesInUnit, getValuesSI, size, toString, toString, toString, toString, zSum

Constructor Detail

MutableFrequencyVector

public MutableFrequencyVector(FrequencyUnit unit)

Parameters:

unit - the unit to use

Method Detail

mutable

public abstract MutableFrequencyVector mutable()

Create a mutable version of this DoubleVector.
The mutable version is created with a shallow copy of the data and the internal copyOnWrite flag set. The first operation in the mutable version that modifies the data shall trigger a deep copy of the data.

Specified by:

mutable in interface DoubleVectorInterface<FrequencyUnit>

Specified by:

mutable in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

MutableDoubleVector<U>; mutable version of this DoubleVector

immutable

public abstract FrequencyVector immutable()

Create a immutable version of this MutableDoubleVector.

Specified by:

immutable in interface MutableDoubleVectorInterface<FrequencyUnit>

Specified by:

immutable in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

DoubleVector<U>; mutable version of this MutableDoubleVector

toDense

public abstract MutableFrequencyVector toDense()

Create a dense version of this DoubleVector.

Specified by:

toDense in interface DoubleVectorInterface<FrequencyUnit>

Specified by:

toDense in interface MutableDoubleVectorInterface<FrequencyUnit>

Specified by:

toDense in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

MutableDoubleVector<U>; dense version of this DoubleVector

toSparse

public abstract MutableFrequencyVector toSparse()

Create a sparse version of this DoubleVector.

Specified by:

toSparse in interface DoubleVectorInterface<FrequencyUnit>

Specified by:

toSparse in interface MutableDoubleVectorInterface<FrequencyUnit>

Specified by:

toSparse in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

MutableDoubleVector<U>; sparse version of this DoubleVector

get

public final Frequency get(int index)
                    throws ValueException

Retrieve the value stored at a specified index as a DoubleScalar.

Specified by:

get in interface DoubleVectorInterface<FrequencyUnit>

Overrides:

get in class MutableDoubleVector.Rel<FrequencyUnit>

Parameters:

index - int; index of the value to retrieve

Returns:

DoubleScalar<U>; the strongly typed value of the selected cell

Throws:

ValueException - when index out of range (index < 0 or index >= size())

copy

public final MutableFrequencyVector copy()

Create a deep copy of this MutableDoubleVector.

Specified by:

copy in interface MutableDoubleVectorInterface<FrequencyUnit>

Specified by:

copy in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

DoubleVector<U>; deep copy of this MutableDoubleVector

plus

public final FrequencyVector plus(FrequencyVector rel)
                           throws ValueException

Add a Relative value to this Relative value for a vector or matrix. The addition is done value by value and store the result in a new Relative value. If both operands are sparse, the result is a sparse vector or matrix, otherwise the result is a dense vector or matrix.

Parameters:

rel - the right operand

Returns:

the addition of this vector and the operand

Throws:

ValueException - in case this vector or matrix and the operand have a different size

minus

public final FrequencyVector minus(FrequencyVector rel)
                            throws ValueException

Subtract a Relative value from this Relative value for a vector or matrix. The subtraction is done value by value and store the result in a new Relative value. If both operands are sparse, the result is a sparse vector or matrix, otherwise the result is a dense vector or matrix.

Parameters:

rel - the right operand

Returns:

the subtraction of this vector and the operand

Throws:

ValueException - in case this vector or matrix and the operand have a different size

times

public final FrequencyVector times(FrequencyVector rel)
                            throws ValueException

Multiply a Relative value with this Relative value for a vector or matrix. The multiplication is done value by value and store the result in a new Relative value. If both operands are dense, the result is a dense vector or matrix, otherwise the result is a sparse vector or matrix.

Parameters:

rel - the right operand

Returns:

the multiplication of this vector and the operand

Throws:

ValueException - in case this vector or matrix and the operand have a different size

divide

public final FrequencyVector divide(FrequencyVector rel)
                             throws ValueException

Divide this Relative value by a Relative value for a vector or matrix. The division is done value by value and store the result in a new Relative value. If both operands are dense, the result is a dense vector or matrix, otherwise the result is a sparse vector or matrix.

Parameters:

rel - the right operand

Returns:

the division of this vector and the operand

Throws:

ValueException - in case this vector or matrix and the operand have a different size

plus

public final FrequencyVector plus(MutableFrequencyVector rel)
                           throws ValueException

Add a Relative value to this Relative value for a vector or matrix. The addition is done value by value and store the result in a new Relative value. If both operands are sparse, the result is a sparse vector or matrix, otherwise the result is a dense vector or matrix.

Parameters:

rel - the right operand

Returns:

the addition of this vector and the operand

Throws:

ValueException - in case this vector or matrix and the operand have a different size

minus

public final FrequencyVector minus(MutableFrequencyVector rel)
                            throws ValueException

Subtract a Relative value from this Relative value for a vector or matrix. The subtraction is done value by value and store the result in a new Relative value. If both operands are sparse, the result is a sparse vector or matrix, otherwise the result is a dense vector or matrix.

Parameters:

rel - the right operand

Returns:

the subtraction of this vector and the operand

Throws:

ValueException - in case this vector or matrix and the operand have a different size

times

public final FrequencyVector times(MutableFrequencyVector rel)
                            throws ValueException

Multiply a Relative value with this Relative value for a vector or matrix. The multiplication is done value by value and store the result in a new Relative value. If both operands are dense, the result is a dense vector or matrix, otherwise the result is a sparse vector or matrix.

Parameters:

rel - the right operand

Returns:

the multiplication of this vector and the operand

Throws:

ValueException - in case this vector or matrix and the operand have a different size

divide

public final FrequencyVector divide(MutableFrequencyVector rel)
                             throws ValueException

Divide this Relative value by a Relative value for a vector or matrix. The division is done value by value and store the result in a new Relative value. If both operands are dense, the result is a dense vector or matrix, otherwise the result is a sparse vector or matrix.

Parameters:

rel - the right operand

Returns:

the division of this vector and the operand

Throws:

ValueException - in case this vector or matrix and the operand have a different size

abs

public final MutableFrequencyVector abs()

Set the value(s) to their absolute value.

Specified by:

abs in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

abs in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

T; the modified T

acos

public final MutableFrequencyVector acos()

Set the value(s) to the arc cosine of the value(s); the resulting angle is in the range 0.0 through pi.

Specified by:

acos in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

acos in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

T; the modified T

asin

public final MutableFrequencyVector asin()

Set the value(s) to the arc sine of the value(s); the resulting angle is in the range -pi/2 through pi/2.

Specified by:

asin in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

asin in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

T; the modified T

atan

public final MutableFrequencyVector atan()

Set the value(s) to the arc tangent of the value(s); the resulting angle is in the range -pi/2 through pi/2.

Specified by:

atan in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

atan in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

T; the modified T

cbrt

public final MutableFrequencyVector cbrt()

Set the value(s) to the(ir) cube root.

Specified by:

cbrt in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

cbrt in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

T; the modified T

ceil

public final MutableFrequencyVector ceil()

Set the value(s) to the smallest (closest to negative infinity) value(s) that are greater than or equal to the argument and equal to a mathematical integer.

Specified by:

ceil in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

ceil in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

T; the modified T

cos

public final MutableFrequencyVector cos()

Set the value(s) to the trigonometric cosine of the value(s).

Specified by:

cos in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

cos in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

T; the modified T

cosh

public final MutableFrequencyVector cosh()

Set the value(s) to the hyperbolic cosine of the value(s).

Specified by:

cosh in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

cosh in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

T; the modified T

exp

public final MutableFrequencyVector exp()

Set the value(s) to Euler's number e raised to the power of the value(s).

Specified by:

exp in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

exp in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

T; the modified T

expm1

public final MutableFrequencyVector expm1()

Set the value(s) to Euler's number e raised to the power of the value(s) minus 1 (e^x - 1).

Specified by:

expm1 in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

expm1 in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

T; the modified T

floor

public final MutableFrequencyVector floor()

Set the value(s) to the largest (closest to positive infinity) value(s) that are less than or equal to the argument and equal to a mathematical integer.

Specified by:

floor in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

floor in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

T; the modified T

log

public final MutableFrequencyVector log()

Set the value(s) to the natural logarithm (base e) of the value(s).

Specified by:

log in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

log in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

T; the modified T

log10

public final MutableFrequencyVector log10()

Set the value(s) to the base 10 logarithm of the value(s).

Specified by:

log10 in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

log10 in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

T; the modified T

log1p

public final MutableFrequencyVector log1p()

Set the value(s) to the natural logarithm of the sum of the value(s) and 1.

Specified by:

log1p in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

log1p in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

T; the modified T

pow

public final MutableFrequencyVector pow(double x)

Set the value(s) to the value(s) raised to the power of the argument.

Specified by:

pow in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

pow in class MutableDoubleVector.Rel<FrequencyUnit>

Parameters:

x - double; the value to use as the power

Returns:

T; the modified T

rint

public final MutableFrequencyVector rint()

Set the value(s) to the value(s) that are closest in value to the argument and equal to a mathematical integer.

Specified by:

rint in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

rint in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

T; the modified T

round

public final MutableFrequencyVector round()

Set the value(s) to the closest long to the argument with ties rounding up.

Specified by:

round in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

round in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

T; the modified T

signum

public final MutableFrequencyVector signum()

Set the value(s) to the signum function of the value(s); zero if the argument is zero, 1.0 if the argument is greater than zero, -1.0 if the argument is less than zero.

Specified by:

signum in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

signum in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

T; the modified T

sin

public final MutableFrequencyVector sin()

Set the value(s) to the trigonometric sine of the value(s).

Specified by:

sin in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

sin in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

T; the modified T

sinh

public final MutableFrequencyVector sinh()

Set the value(s) to the hyperbolic sine of the value(s).

Specified by:

sinh in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

sinh in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

T; the modified T

sqrt

public final MutableFrequencyVector sqrt()

Set the value(s) to the correctly rounded positive square root of the value(s).

Specified by:

sqrt in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

sqrt in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

T; the modified T

tan

public final MutableFrequencyVector tan()

Set the value(s) to the trigonometric tangent of the value(s).

Specified by:

tan in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

tan in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

T; the modified T

tanh

public final MutableFrequencyVector tanh()

Set the value(s) to the hyperbolic tangent of the value(s).

Specified by:

tanh in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

tanh in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

T; the modified T

toDegrees

public final MutableFrequencyVector toDegrees()

Set the value(s) to approximately equivalent angle(s) measured in degrees.

Specified by:

toDegrees in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

toDegrees in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

T; the modified T

toRadians

public final MutableFrequencyVector toRadians()

Set the value(s) to approximately equivalent angle(s) measured in radians.

Specified by:

toRadians in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

toRadians in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

T; the modified T

inv

public final MutableFrequencyVector inv()

Set the value(s) to the complement (1.0/x) of the value(s).

Specified by:

inv in interface MathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

inv in class MutableDoubleVector.Rel<FrequencyUnit>

Returns:

T; the modified T

multiplyBy

public final MutableFrequencyVector multiplyBy(double constant)

Scale the value(s) by a factor.

Specified by:

multiplyBy in interface DoubleMathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

multiplyBy in class MutableDoubleVector.Rel<FrequencyUnit>

Parameters:

constant - double; the multiplier

Returns:

T; the modified T

divideBy

public final MutableFrequencyVector divideBy(double constant)

Scale the value(s) by the inverse of a factor; i.e. a divisor.

Specified by:

divideBy in interface DoubleMathFunctions<MutableDoubleVector.Rel<FrequencyUnit>>

Overrides:

divideBy in class MutableDoubleVector.Rel<FrequencyUnit>

Parameters:

constant - double; the divisor

Returns:

T; the modified T