Package org.goplanit.od.skim

Class OdSkimMatrix

java.lang.Object

org.goplanit.utils.id.IdAbleImpl

org.goplanit.utils.od.OdDataImpl<T>

org.goplanit.utils.od.OdMatrixImpl<T,org.ojalgo.array.Array2D<T>>

org.goplanit.utils.od.OdPrimitiveMatrix<Double>

org.goplanit.od.skim.OdSkimMatrix

All Implemented Interfaces:

Comparable<IdAble>, Iterable<Double>, IdAble, OdData<Double>, OdMatrix<Double,org.ojalgo.array.Array2D<Double>>

public class OdSkimMatrix
extends OdPrimitiveMatrix<Double>

This class stores an OD Skim matrix.

Author:

gman6028, markr

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	OdSkimMatrix.OdSkimMatrixIterator	Wrapper around primitive matrix iterator

Field Summary

Fields inherited from class org.goplanit.utils.od.OdMatrixImpl

matrixContents

Fields inherited from class org.goplanit.utils.od.OdDataImpl

zones

Constructor Summary

Constructors

Constructor	Description
OdSkimMatrix(OdSkimMatrix other)	copy constructor
OdSkimMatrix(OdZones zones, OdSkimSubOutputType odSkimOutputType)	Constructor

Method Summary

Modifier and Type	Method	Description
OdSkimSubOutputType	getOdSkimOutputType()	Returns the type of the current OD skim matrix
OdSkimMatrix.OdSkimMatrixIterator	iterator()	Returns an iterator which can iterate through all the origin-destination cells in the matrix
OdSkimMatrix	shallowClone()	Create a shallow copy of this entity

Methods inherited from class org.goplanit.utils.od.OdPrimitiveMatrix

deepClone, getValue, getValue, setValue

Methods inherited from class org.goplanit.utils.od.OdDataImpl

getNumberOfOdZones, getOdZones

Methods inherited from class org.goplanit.utils.id.IdAbleImpl

equals, generateAndSetId, generateId, getId, hashCode, setId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.goplanit.utils.id.IdAble

compareTo, getId, idEquals, idHashCode

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.goplanit.utils.od.OdData

getNumberOfOdZones

Constructor Detail

OdSkimMatrix

public OdSkimMatrix(OdZones zones,
                    OdSkimSubOutputType odSkimOutputType)

Constructor

Parameters:

zones - holding the zones in the network

odSkimOutputType - the skim output type for this OD skim matrix

OdSkimMatrix

public OdSkimMatrix(OdSkimMatrix other)

copy constructor

Parameters:

other - to copy

Method Detail

getOdSkimOutputType

public OdSkimSubOutputType getOdSkimOutputType()

Returns the type of the current OD skim matrix

Returns:

the OD skim matrix type for the current OD skim matrix

shallowClone

public OdSkimMatrix shallowClone()

Create a shallow copy of this entity

Specified by:

shallowClone in interface IdAble

Specified by:

shallowClone in interface OdData<Double>

Specified by:

shallowClone in class OdPrimitiveMatrix<Double>

Returns:

shallow copy of entity

iterator

public OdSkimMatrix.OdSkimMatrixIterator iterator()

Returns an iterator which can iterate through all the origin-destination cells in the matrix

Specified by:

iterator in interface Iterable<Double>

Specified by:

iterator in interface OdData<Double>

Specified by:

iterator in interface OdMatrix<Double,org.ojalgo.array.Array2D<Double>>

Specified by:

iterator in class OdPrimitiveMatrix<Double>

Returns:

iterator through all the origin-destination cells