PyDistributionPlugin.DestinationChoiceModelParams

class DestinationChoiceModelParams

DestinationChoiceModelParams : parameters for the Destination Choice Model of the DistributionExperiment.

Details

  • 1-mSideTotalsConstr: true/false option whether to fit the values to the Generated/Attracted vectors or not. - 2-mNSideTotalsIterations: maximum number of iterations when applying the Total side constraints. - 3-mMaxRelativeGap: maximum relative changes in the probabilities from the ith iteration to the (i+1)th one. - 4-mConstraintError: upper bound to the maximum error between the trips calculated and the Generation/Attraction vector simulated. Same for all Distribution Models

Inheritance diagram of PyDistributionPlugin.DestinationChoiceModelParams

Synopsis

Methods

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

__init__()
getConstraintError()
Return type:

float

Gets the upper bound to the maximum error between the side totals trip calculated between successive side (G/A) totals iterations.

getMaxRelativeGap()
Return type:

float

Gets the upper bound to the maximum relative gap between the side totals trip calculated between successive side (G/A) totals iterations.

getMaxSideTotalsIterations()
Return type:

int

Gets the upper bound to the maximum number of iterations of fitting the trips to the input Generation/Attraction vector.

getSideTotalsConstraint()
Return type:

bool

Gets the option to adjust or not the G/A values to the input Generation/Attraction vector.

setConstraintError(iConstrError)
Parameters:

iConstrError – float

Sets the upper bound to the maximum error between the side totals trip calculated between successive side (G/A) totals iterations.

setMaxRelativeGap(iRelativeGap)
Parameters:

iRelativeGap – float

Sets the upper bound to the maximum relative gap between the side total trips calculated between successive side (G/A) totals iterations.

setMaxSideTotalsIterations(iOption)
Parameters:

iOption – int

Sets the upper bound to the maximum number of iterations of fitting of the trips to the input Generation/Attraction vector.

setSideTotalsConstraint(iOption)
Parameters:

iOption – bool

Sets the option to adjust or not the G/A values to the input Generation/Attraction vector.