Package org.goplanit.od.demand

Class OdDemandMatrix

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.demand.OdDemandMatrix

All Implemented Interfaces:

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

public class OdDemandMatrix
extends OdPrimitiveMatrix<Double>
implements OdDemands

This class handles the OD demand matrix.

Author:

gman6028, markr

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	OdDemandMatrix.OdDemandMatrixIterator	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
OdDemandMatrix(OdDemandMatrix odDemandMatrix)	Copy constructor
OdDemandMatrix(OdZones zones)	Constructor

Method Summary

Modifier and Type	Method	Description
OdDemandMatrix	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.
OdDemandMatrix.OdDemandMatrixIterator	iterator()	Returns an iterator which can iterate through all the origin-destination cells in the matrix
void	multiply(double factor)	Multiply all entries with given factor
OdDemandMatrix	shallowClone()	Create a shallow copy of this entity

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

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

Methods inherited from interface org.goplanit.od.demand.OdDemands

forEachNonZeroDestinationDemand, forEachNonZeroOdDemand

Constructor Detail

OdDemandMatrix

public OdDemandMatrix(OdZones zones)

Constructor

Parameters:

zones - holds the zones defined in the network

OdDemandMatrix

public OdDemandMatrix(OdDemandMatrix odDemandMatrix)

Copy constructor

Parameters:

odDemandMatrix - to copy

Method Detail

iterator

public OdDemandMatrix.OdDemandMatrixIterator 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

multiply

public void multiply(double factor)

Multiply all entries with given factor

Specified by:

multiply in interface OdDemands

Parameters:

factor - to multiply with

shallowClone

public OdDemandMatrix 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 interface OdDemands

Specified by:

shallowClone in class OdPrimitiveMatrix<Double>

Returns:

shallow copy of entity

deepClone

public OdDemandMatrix 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 interface OdDemands

Overrides:

deepClone in class OdPrimitiveMatrix<Double>

Returns:

deep copy of entity