Class HypothesisKL

KL-pattern as a result of a KL-Miner data-mining task
inherits from Hypothesis
namespace: lm.tasks.results

Constructor

No constructor available. Objects of this class could not be instantiated from Lua scripts.

Properties List

ID	Unique identifier (primary key) of the object
KLColAttributeSetting	the KLAttributeSetting for column attribute in this hypothesis
KLRowAttributeSetting	the KLAttributeSetting for row attribute in this hypothesis
Order	Order-index of this hypothesis
Task	the Task, this hypothesis belongs to
Text	Textual representation of this hypothesis
TextHTML	HTML representation of this hypothesis
Weight	Property used for storing eg. primary interest measure value for LM ReverseMiner

Methods List

getColCount ()	Returns the number of columns in KL-contingency table
getFrequency ()	Returns the frequency value from KL-contingency table for a pair row-column given by index-parameters
getID ()	Returns unique identifier (primary key) of the object
getOrder ()	Returns the value of Order property
getRowCount ()	Returns the number of rows in KL-contingency table
getTask ()	Returns the Task this hypothesis belongs to, the value of Task property
getWeight ()	Returns the value of Weight property
checkMutualInfluence ()	Returns a type of relationship between hypothesis and given mutual influence, see HypothesisMutualInfluenceRelationship codes
prepareFTPartialCedentArray ()	Returns array of FTPartialCedents, partial cedents of a given type in this hypothesis
setOrder ()	Sets the value of Order property
setWeight ()	Sets the value of Weight property

Properties

ID  (read-only) : integer

Unique identifier (primary key) of the object
Intherited from: LMWrap

KLColAttributeSetting  (read-only) : KLAttributeSetting

the KLAttributeSetting for column attribute in this hypothesis

KLRowAttributeSetting  (read-only) : KLAttributeSetting

the KLAttributeSetting for row attribute in this hypothesis

Order : integer

Order-index of this hypothesis
Intherited from: Hypothesis

Task  (read-only) : Task

the Task, this hypothesis belongs to
Intherited from: Hypothesis

Text  (read-only) : string

Textual representation of this hypothesis
Intherited from: Hypothesis

TextHTML  (read-only) : string

HTML representation of this hypothesis
Intherited from: Hypothesis

Weight : float

Property used for storing eg. primary interest measure value for LM ReverseMiner
Intherited from: Hypothesis

Methods

getColCount() : integer

Returns the number of columns in KL-contingency table

Returns

• integer - number of columns in KL-contingency table

getFrequency()

Returns the frequency value from KL-contingency table for a pair row-column given by index-parameters

Parameters

• luaTable - to store named parameters

Obligatory named parameters

• nRow : integer - an index of row to return the frequency for
• nCol : integer - an index of column to return the frequency for

Returns

• float - frequency value

getID() : integer

Returns unique identifier (primary key) of the object
Intherited from: LMWrap

Returns

• integer

getOrder() : integer

Returns the value of Order property
Intherited from: Hypothesis

Returns

• integer

getRowCount() : integer

Returns the number of rows in KL-contingency table

Returns

• integer - number of rows in KL-contingency table

getTask() : Task

Returns the Task this hypothesis belongs to, the value of Task property
Intherited from: Hypothesis

Returns

• Task

getWeight() : float

Returns the value of Weight property
Intherited from: Hypothesis

Returns

• float

checkMutualInfluence() : integer

Returns a type of relationship between hypothesis and given mutual influence, see HypothesisMutualInfluenceRelationship codes
Intherited from: Hypothesis

Parameters

• luaTable - to store named parameters

Obligatory named parameters

• pMutualInfluence : MutualInfluence - the Mutual influence to which compare this hypothesis

Returns

• integer - relationship code, see HypothesisMutualInfluenceRelationship codes

prepareFTPartialCedentArray() : luaTable

Returns array of FTPartialCedents, partial cedents of a given type in this hypothesis
Intherited from: Hypothesis

Parameters

• luaTable - to store named parameters

Obligatory named parameters

• nCedentTypeCode : integer - CedentType code to identify the whole cedent partial cedent array to prepare
• nActionStateCode : integer - ActionState code to differentiate between stable and variable parst of antecedent and succedent in Ac4ft-Miner tasks

Returns

• luaTable

setOrder( integer )

Sets the value of Order property
Intherited from: Hypothesis

Parameters

• integer

setWeight( float )

Sets the value of Weight property
Intherited from: Hypothesis

Parameters

• float