Skip navigation links

com.sigmadynamics.sdo.support
Class SDChoiceModel

java.lang.Object
com.sigmadynamics.sdo.support.SDOBase
com.sigmadynamics.sdo.base.SDO
com.sigmadynamics.sdo.support.SDModel
com.sigmadynamics.sdo.base.Model
com.sigmadynamics.sdo.support.SDChoiceModel

All Implemented Interfaces:

ChoiceModelInterface, SDOInterface, ModelInterface, InputProvider

Direct Known Subclasses:

ChoiceModel

public abstract class SDChoiceModel

extends Model

implements ChoiceModelInterface

Since:

3.0

Field Summary

Fields inherited from class com.sigmadynamics.sdo.support.SDOBase

description, internalName, sdExternalName

Constructor Summary

SDChoiceModel()

Method Summary

abstract double	getChoiceLikelihood(java.lang.String choiceId)
abstract int	getChoiceModelCount(ModelCount modelCount, java.lang.String choiceId)
abstract float	getChoiceModelError(ModelError modelError, java.lang.String choiceId)
abstract float	getChoiceModelLift(ModelLift modelLift, java.lang.String choiceId)
abstract float	getChoiceModelQuality(java.lang.String choiceId)
abstract void	recordChoice(java.lang.String choice)

Methods inherited from class com.sigmadynamics.sdo.support.SDModel

getAllAnalysisAttributeIds, getDataStorageDaysToKeep, getDataStorageKeyIds, getDataStoragePartitioningKeyIds, getTargetAttributeId

Methods inherited from class com.sigmadynamics.sdo.support.SDOBase

getDescription, getSDOId, getSDOLabel, getSDOLabelOrId, setDescription, setSDOId, setSDOLabel

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sigmadynamics.sdo.interfaces.ModelInterface

resetModelData, shouldRandomizePredictions

Methods inherited from interface com.sigmadynamics.server.rtis.PredictionEngine.InputProvider

provideInput

Methods inherited from interface com.sigmadynamics.sdo.interfaces.client.SDOInterface

getDescription, getSDOId, getSDOLabel, getSDOLabelOrId

Constructor Detail

SDChoiceModel

public SDChoiceModel()

Method Detail

recordChoice

public abstract void recordChoice(java.lang.String choice)

Specified by:

recordChoice in interface ChoiceModelInterface

Parameters:

choice - sdo id of choice

getChoiceLikelihood

public abstract double getChoiceLikelihood(java.lang.String choiceId)

Specified by:

getChoiceLikelihood in interface ChoiceModelInterface

Parameters:

choiceId - sdo id of choice

Returns:

likelihood of a choice, a real number between 0 and 1 inclusive

getChoiceModelQuality

public abstract float getChoiceModelQuality(java.lang.String choiceId)

Specified by:

getChoiceModelQuality in interface ChoiceModelInterface

Parameters:

choiceId - sdo id of choice

Returns:

quality for a choice model, a real number between 0 and 1 inclusive

getChoiceModelCount

public abstract int getChoiceModelCount(ModelCount modelCount,
                                        java.lang.String choiceId)

Specified by:

getChoiceModelCount in interface ChoiceModelInterface

Parameters:

modelCount - a value of enum type ModelCount, specifying the count type

choiceId - sdo id of choice

Returns:

counts in a choice model, a non-negative integer

See Also:

ModelCount

getChoiceModelLift

public abstract float getChoiceModelLift(ModelLift modelLift,
                                         java.lang.String choiceId)

Specified by:

getChoiceModelLift in interface ChoiceModelInterface

Parameters:

modelLift - a value of enum type ModelLift, specifying the lift type

choiceId - sdo id of choice

Returns:

lift of a choice model, a real number of type float

See Also:

ModelLift

getChoiceModelError

public abstract float getChoiceModelError(ModelError modelError,
                                          java.lang.String choiceId)

Specified by:

getChoiceModelError in interface ChoiceModelInterface

Parameters:

modelError - a value of enum type ModelError, specifying the error type

choiceId - sdo id of choice

Returns:

error of a choice model, a real number of type float

See Also:

ModelError

Skip navigation links