LISp-Miner Control Language Reference, version: 27.13.01 of 25 Aug 2017

Class HypothesisFT

4ft-association rule as a result of a 4ft-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

AverageDifference  Average Difference interest measure of the association rule
Confidence  Confidence of the association rule
DoubleFoundedImplication  Double Founded Implication interest measure of the association rule
FoundedEquivalence  Founded Equivalence interest measure of the association rule
FrequencyA  a-frequency from the contingency table
FrequencyB  b-frequency from the contingency table
FrequencyC  c-frequency from the contingency table
FrequencyD  d-frequency from the contingency table
ID  Unique identifier (primary key) of the object
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

getAverageDifference () Returns the value of AverageDifference property
getConfidence () Returns the value of Confidence property
getDoubleFoundedImplication () Returns the value of FoundedEquivalence property
getFoundedEquivalence () Returns the value of FoundedEquivalence property
getID () Returns unique identifier (primary key) of the object
getOrder () Returns the value of Order property
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

AverageDifference  (read-only) : float
Average Difference interest measure of the association rule
Confidence  (read-only) : float
Confidence of the association rule
DoubleFoundedImplication  (read-only) : float
Double Founded Implication interest measure of the association rule
FoundedEquivalence  (read-only) : float
Founded Equivalence interest measure of the association rule
FrequencyA  (read-only) : integer
a-frequency from the contingency table
FrequencyB  (read-only) : integer
b-frequency from the contingency table
FrequencyC  (read-only) : integer
c-frequency from the contingency table
FrequencyD  (read-only) : integer
d-frequency from the contingency table
ID  (read-only) : integer
Unique identifier (primary key) of the object
Intherited from: LMWrap
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

getAverageDifference() : float
Returns the value of AverageDifference property

Returns

  • float
getConfidence() : float
Returns the value of Confidence property

Returns

  • float
getDoubleFoundedImplication() : float
Returns the value of FoundedEquivalence property

Returns

  • float
getFoundedEquivalence() : float
Returns the value of FoundedEquivalence property

Returns

  • float
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
getTask() : Task
Returns the Task this hypothesis belongs to, the value of Task property
Intherited from: Hypothesis

Returns

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

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