org.opentrafficsim.core.value.vdouble.vector

Interface ReadOnlyDoubleVectorFunctions<U extends Unit<U>>

Type Parameters:

U - Unit of the vector

All Known Implementing Classes:

DoubleVector, DoubleVector.Abs, DoubleVector.Abs.Dense, DoubleVector.Abs.Sparse, DoubleVector.Rel, DoubleVector.Rel.Dense, DoubleVector.Rel.Sparse, MutableDoubleVector, MutableDoubleVector.Abs, MutableDoubleVector.Abs.Dense, MutableDoubleVector.Abs.Sparse, MutableDoubleVector.Rel, MutableDoubleVector.Rel.Dense, MutableDoubleVector.Rel.Sparse

public interface ReadOnlyDoubleVectorFunctions<U extends Unit<U>>

Methods that operate on DoubleVector but do not modify the contents of the DoubleVector.

This file was generated by the OpenTrafficSim value classes generator, 26 jun, 2015

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

Version:

26 jun, 2015

Author:

Alexander Verbraeck, Peter Knoppers

Method Summary

Modifier and Type	Method and Description
int	cardinality() Count the number of cells that have a non-zero value (ignores tolerance).
DoubleScalar<U>	get(int index) Retrieve the value stored at a specified index as a DoubleScalar.
double	getInUnit(int index) Retrieve the value stored at a specified position in the original unit.
double	getInUnit(int index, U targetUnit) Retrieve the value stored at a specified position converted into a specified unit.
double	getSI(int index) Retrieve the value stored at a specified position in the standard SI unit.
int	size() Retrieve the size of the vector.
double	zSum() Compute the sum of all values of this vector.

Method Detail

size

int size()

Retrieve the size of the vector.

Returns:

int; the size of the vector

cardinality

int cardinality()

Count the number of cells that have a non-zero value (ignores tolerance).

Returns:

int; the number of cells having non-zero value

getSI

double getSI(int index)
      throws ValueException

Retrieve the value stored at a specified position in the standard SI unit.

Parameters:

index - int; index of the value to retrieve

Returns:

double; value at position index in the standard SI unit

Throws:

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

getInUnit

double getInUnit(int index)
          throws ValueException

Retrieve the value stored at a specified position in the original unit.

Parameters:

index - int; index of the value to retrieve

Returns:

double; value at position index in the original unit

Throws:

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

getInUnit

double getInUnit(int index,
                 U targetUnit)
          throws ValueException

Retrieve the value stored at a specified position converted into a specified unit.

Parameters:

index - int; index of the value to retrieve

targetUnit - U; the unit for the result

Returns:

double; value at position index converted into the specified unit

Throws:

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

get

DoubleScalar<U> get(int index)
             throws ValueException

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

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

zSum

double zSum()

Compute the sum of all values of this vector.

Returns:

double; the sum of all values of this vector