Package org.goplanit.od.path

Class OdPathMatrix

java.lang.Object

org.goplanit.utils.id.IdAbleImpl

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

org.goplanit.utils.od.OdMatrixImpl<T,T[][]>

org.goplanit.utils.od.OdNonPrimitiveMatrix<DirectedPath>

org.goplanit.od.path.OdPathMatrix

All Implemented Interfaces:

Cloneable, Comparable<IdAble>, Iterable<DirectedPath>, OdPaths, IdAble, OdData<DirectedPath>, OdMatrix<DirectedPath,DirectedPath[][]>

public class OdPathMatrix
extends OdNonPrimitiveMatrix<DirectedPath>
implements OdPaths

This class stores the path objects from each origin to each destination in a full matrix form

Author:

gman6028, markr

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	OdPathMatrix.OdPathMatrixIterator	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
OdPathMatrix(OdPathMatrix odPathMatrix)	Copy constructor (shallow copy of matrix contents)
OdPathMatrix(IdGroupingToken groupId, OdZones zones)	Constructor

Method Summary

Modifier and Type	Method	Description
OdPathMatrix	clone()	Create a shallow copy of this entity
OdPathMatrix.OdPathMatrixIterator	iterator()	Returns an iterator which can iterate through all the origin-destination cells in the matrix

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

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

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, getValue, getValue, setValue

Constructor Detail

OdPathMatrix

public OdPathMatrix(IdGroupingToken groupId,
                    OdZones zones)

Constructor

Parameters:

groupId - contiguous id generation within this group for instances of this class

zones - the zones being used

OdPathMatrix

public OdPathMatrix(OdPathMatrix odPathMatrix)

Copy constructor (shallow copy of matrix contents)

Parameters:

odPathMatrix - to copy from

Method Detail

iterator

public OdPathMatrix.OdPathMatrixIterator iterator()

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

Specified by:

iterator in interface Iterable<DirectedPath>

Specified by:

iterator in interface OdData<DirectedPath>

Specified by:

iterator in interface OdMatrix<DirectedPath,DirectedPath[][]>

Specified by:

iterator in class OdNonPrimitiveMatrix<DirectedPath>

Returns:

iterator through all the origin-destination cells

clone

public OdPathMatrix clone()

Create a shallow copy of this entity

Specified by:

clone in interface IdAble

Specified by:

clone in class OdMatrixImpl<DirectedPath,DirectedPath[][]>

Returns:

shallow copy of entity