Package org.goplanit.utils.od

Class OdMatrixImpl<T,U>

java.lang.Object

org.goplanit.utils.id.IdAbleImpl

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

org.goplanit.utils.od.OdMatrixImpl<T,U>

All Implemented Interfaces:

Comparable<IdAble>, Iterable<T>, IdAble, OdData<T>, OdMatrix<T,U>

Direct Known Subclasses:

OdNonPrimitiveMatrix, OdPrimitiveMatrix

public abstract class OdMatrixImpl<T,U>
extends OdDataImpl<T>
implements OdMatrix<T,U>

This class contains common methods for handling origin-demand matrices.

Author:

gman6028, markr

Field Summary

Fields

Modifier and Type	Field	Description
protected U	matrixContents	matrix of data values

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

zones

Constructor Summary

Constructors

Constructor	Description
OdMatrixImpl(Class<? extends IdAble> idTokenClass, IdGroupingToken idToken, OdZones zones, U matrixContents)	Constructor for Od matrix containing primitives, i.e.
OdMatrixImpl(OdMatrixImpl<T,U> other)	Copy Constructor (shallow copy of matrix contents)

Method Summary

Modifier and Type	Method	Description
abstract OdMatrixImpl<T,U>	deepClone()	An id entity should always support a deep copy, i.e., all "owned" members will be deep copied when a clone of this instance is created via this call.
abstract OdMatrixIterator<T,U>	iterator()	Returns an iterator which can iterate through all the origin-destination cells in the matrix
abstract OdMatrixImpl<T,U>	shallowClone()	Create a shallow copy of this entity

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

Field Detail

matrixContents

protected U matrixContents

matrix of data values

Constructor Detail

OdMatrixImpl

public OdMatrixImpl(Class<? extends IdAble> idTokenClass,
                    IdGroupingToken idToken,
                    OdZones zones,
                    U matrixContents)

Constructor for Od matrix containing primitives, i.e. number based

Parameters:

idTokenClass - to use for id generation

idToken - to use for the matrix id

zones - holder for zones considered in the matrix

matrixContents - container for the matrix contents

OdMatrixImpl

public OdMatrixImpl(OdMatrixImpl<T,U> other)

Copy Constructor (shallow copy of matrix contents)

Parameters:

other - to copy

Method Detail

iterator

public abstract OdMatrixIterator<T,U> iterator()

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

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface OdData<T>

Specified by:

iterator in interface OdMatrix<T,U>

Returns:

iterator through all the origin-destination cells

shallowClone

public abstract OdMatrixImpl<T,U> shallowClone()

Create a shallow copy of this entity

Specified by:

shallowClone in interface IdAble

Specified by:

shallowClone in interface OdData<T>

Specified by:

shallowClone in class OdDataImpl<T>

Returns:

shallow copy of entity

deepClone

public abstract OdMatrixImpl<T,U> deepClone()

An id entity should always support a deep copy, i.e., all "owned" members will be deep copied when a clone of this instance is created via this call. To be used with caution if not called by managed id container related code

Specified by:

deepClone in interface IdAble

Specified by:

deepClone in class OdDataImpl<T>

Returns:

deep copy of entity