LogitChoiceModel (planit-all 0.3.0 API)

java.lang.Object
- org.goplanit.component.PlanitComponent<LogitChoiceModel>
- - org.goplanit.path.choice.logit.LogitChoiceModel

All Implemented Interfaces:

Serializable, Cloneable, 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)`	Copy constructor
`protected`	`LogitChoiceModel(IdGroupingToken groupId)`	Constructor

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type Method Description

abstract LogitChoiceModel clone()
Create a shallow copy of this entity
- Methods inherited from class org.goplanit.component.PlanitComponent
  equals, getComponentType, getExternalId, getId, getIdGroupingToken, getKnownSupportedEventTypes, getXmlId, hashCode, onPlanitComponentEvent, reset, setExternalId, setXmlId
- Methods inherited from class java.lang.Object
  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
  hasExternalId, hasXmlId
- 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)
```
    Copy constructor
    
    Parameters:
    
    other - to copy
- Method Detail
  - clone
```
public abstract LogitChoiceModel clone()
```
    Create a shallow copy of this entity
    
    Specified by:
    
    clone in interface IdAble
    
    Specified by:
    
    clone in class PlanitComponent<LogitChoiceModel>
    
    Returns:
    
    shallow copy of entity