Package org.goplanit.path.choice.logit

Class MultinomialLogit

java.lang.Object

org.goplanit.component.PlanitComponent<LogitChoiceModel>

org.goplanit.path.choice.logit.LogitChoiceModel

org.goplanit.path.choice.logit.MultinomialLogit

All Implemented Interfaces:

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

public class MultinomialLogit
extends LogitChoiceModel

MNL choice model implementation

Author:

markr

See Also:

Serialized Form

Field Summary

Fields inherited from class org.goplanit.path.choice.logit.LogitChoiceModel

MNL

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Map<String,String>	collectSettingsAsKeyValueMap()	Provide all the settings of this particular component by name and value, where each value is a string representation of the underlying entity
MultinomialLogit	deepClone()	deep clone on planit component should attempt to also update internal dependencies between deep cloned containers where possible
void	reset()	All components should be able to reset going back to some representative initial state
MultinomialLogit	shallowClone()	Create a shallow copy of this entity

Methods inherited from class org.goplanit.component.PlanitComponent

equals, getComponentType, getExternalId, getId, getIdGroupingToken, getKnownSupportedEventTypes, getXmlId, hashCode, onPlanitComponentEvent, 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

Constructor Detail

MultinomialLogit

protected MultinomialLogit(IdGroupingToken groupId)

Constructor

Parameters:

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

MultinomialLogit

protected MultinomialLogit(MultinomialLogit other,
                           boolean deepCopy)

Copy constructor

Parameters:

other - to copy

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

Method Detail

shallowClone

public MultinomialLogit shallowClone()

Create a shallow copy of this entity

Specified by:

shallowClone in interface IdAble

Specified by:

shallowClone in class LogitChoiceModel

Returns:

shallow copy of entity

deepClone

public MultinomialLogit 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 LogitChoiceModel

Returns:

deep copy of entity

reset

public void reset()

All components should be able to reset going back to some representative initial state

Specified by:

reset in class PlanitComponent<LogitChoiceModel>

collectSettingsAsKeyValueMap

public Map<String,String> collectSettingsAsKeyValueMap()

Provide all the settings of this particular component by name and value, where each value is a string representation of the underlying entity

Specified by:

collectSettingsAsKeyValueMap in class PlanitComponent<LogitChoiceModel>

Returns:

name-value map of all (user configurable) settings