Package org.goplanit.path.choice.logit

Class LogitChoiceModel

java.lang.Object

org.goplanit.component.PlanitComponent<LogitChoiceModel>

org.goplanit.path.choice.logit.LogitChoiceModel

All Implemented Interfaces:

Serializable, Comparable<IdAble>, EventListener, PlanitComponentListener, EventListener, ExternalIdAble, IdAble

Direct Known Subclasses:

MultinomialLogit

public abstract class LogitChoiceModel
extends PlanitComponent<LogitChoiceModel>
implements Serializable

The logit choice model base class. Different logit choice models lead to different behaviour regarding choices.

Author:

markr

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	MNL	short hand for MNL class type

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LogitChoiceModel(LogitChoiceModel other, boolean deepCopy)	Copy constructor
protected	LogitChoiceModel(IdGroupingToken groupId)	Constructor

Method Summary

Modifier and Type	Method	Description
abstract LogitChoiceModel	deepClone()	deep clone on planit component should attempt to also update internal dependencies between deep cloned containers where possible
abstract LogitChoiceModel	shallowClone()	Create a shallow copy of this entity

Methods inherited from class org.goplanit.component.PlanitComponent

collectSettingsAsKeyValueMap, equals, getComponentType, getExternalId, getId, getIdGroupingToken, getKnownSupportedEventTypes, getXmlId, hashCode, onPlanitComponentEvent, reset, setExternalId, setXmlId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.goplanit.utils.event.EventListener

hasKnownSupportedEventTypes

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

appendExternalId, appendExternalId, getIdsAsString, getSplitExternalId, getSplitExternalId, hasExternalId, hasXmlId, setXmlId

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

compareTo, idEquals, idHashCode

Field Detail

MNL

public static final String MNL

short hand for MNL class type

Constructor Detail

LogitChoiceModel

protected LogitChoiceModel(IdGroupingToken groupId)

Constructor

Parameters:

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

LogitChoiceModel

protected LogitChoiceModel(LogitChoiceModel other,
                           boolean deepCopy)

Copy constructor

Parameters:

other - to copy

deepCopy - when true, create a deep copy, shallow copy otherwise

Method Detail

shallowClone

public abstract LogitChoiceModel shallowClone()

Create a shallow copy of this entity

Specified by:

shallowClone in interface IdAble

Specified by:

shallowClone in class PlanitComponent<LogitChoiceModel>

Returns:

shallow copy of entity

deepClone

public abstract LogitChoiceModel deepClone()

deep clone on planit component should attempt to also update internal dependencies between deep cloned containers where possible

Specified by:

deepClone in interface IdAble

Specified by:

deepClone in class PlanitComponent<LogitChoiceModel>

Returns:

deep copy of entity