org.djunits.value.vdouble.vector

Class FrequencyVector

java.lang.Object

org.djunits.value.AbstractValue<U>

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

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

org.djunits.value.vdouble.vector.FrequencyVector

All Implemented Interfaces:

Serializable, FunctionsRel<FrequencyUnit,DoubleVector.Abs<FrequencyUnit>,DoubleVector.Rel<FrequencyUnit>>, Relative, Value<FrequencyUnit>, DoubleVectorInterface<FrequencyUnit>

Direct Known Subclasses:

FrequencyVector.Dense, FrequencyVector.Sparse

public abstract class FrequencyVector
extends DoubleVector.Rel<FrequencyUnit>

Immutable 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	FrequencyVector.Dense Double Dense Relative Immutable Frequency class.
static class	FrequencyVector.Sparse Double Sparse Relative Immutable Frequency class.

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

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

Field Summary

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

data

Constructor Summary

Constructors

Constructor and Description
FrequencyVector(FrequencyUnit unit)

Method Summary

Modifier and Type	Method and Description
FrequencyVector	divide(FrequencyVector rel) Divide this Relative value by a Relative value for a vector or matrix.
Frequency	get(int index) Retrieve the value stored at a specified index as a DoubleScalar.
FrequencyVector	minus(FrequencyVector rel) Subtract a Relative value from this Relative value for a vector or matrix.
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	times(FrequencyVector rel) Multiply a Relative value with this Relative value for a vector or matrix.
abstract FrequencyVector	toDense() Create a dense version of this DoubleVector.
abstract FrequencyVector	toSparse() Create a sparse version of this DoubleVector.

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

divide, minus, plus, plus, times

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

Constructor Detail

FrequencyVector

public FrequencyVector(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 DoubleVector.Rel<FrequencyUnit>

Returns:

MutableDoubleVector<U>; mutable version of this DoubleVector

toDense

public abstract FrequencyVector toDense()

Create a dense version of this DoubleVector.

Specified by:

toDense in interface DoubleVectorInterface<FrequencyUnit>

Specified by:

toDense in class DoubleVector.Rel<FrequencyUnit>

Returns:

MutableDoubleVector<U>; dense version of this DoubleVector

toSparse

public abstract FrequencyVector toSparse()

Create a sparse version of this DoubleVector.

Specified by:

toSparse in interface DoubleVectorInterface<FrequencyUnit>

Specified by:

toSparse in class DoubleVector.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 DoubleVector.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())

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