LISp-Miner Control Language Reference, version: 27.15.01 of 27 Oct 2017

Class KLQuantifierSetting

Set of parameters describing one KL-quantifier, a criterion on interest measure comparing it to a threshold value
inherits from LMWrap
namespace: lm.tasks.settings

Constructor

KLQuantifierSetting()
Creates a new object of this class

Parameters

  • luaTable - to store named parameters

Obligatory named parameters

  • pTaskKL : TaskKL - to which this quantifier setting belongs
  • nKLQuantifierTypeCode : integer - KLQuantifierType code to define this quantifier type

Optional named parameters

  • nCompareTypeCode : integer - CompareType code to define relation between interest measure and threshold value
  • nKLQuantifierValueTypeCode : integer - KLQuantifierValueType code describing threshold value units
  • dThresholdValue : float - universal threshold value (will be assigned to the proper parameter for the given quantifier type)
  • nOrder : integer - position of the quantifier in the list of quantifiers of its task

Properties List

FromCol  Absolute or relative index of the leKL boundary of range for columns. Relative position is given by a negative number
FromRow  Absolute or relative index of the leKL boundary of range for rows. Relative position is given by a negative number
GenerationHintFlag  If there are available hints from the last task run
GenerationHintValueMax  Hint from the last task run - the lowest found interest measure for this quantifier
GenerationHintValueMin  Hint from the last task run - the lowest found interest measure for this quantifier
ID  Unique identifier (primary key) of the object
KendallTauBAbsValueFlag  Whether the Kendall's coefficient TauB values should be in positive interval only, e.g. <0;1>
Note  Additional note to this partial cedent
Order  Order-index of this partial cedent in array of partial cedent of its TaskKL
RangeRelFlag  If the range for rows and cols is specified in percentage form
ThresholdValue  KL-Quantifiers threshold value
ToCol  Absolute or relative index of the right boundary of range for columns. Relative position is given by a negative number
ToRow  Absolute or relative index of the right boundary of range for rows. Relative position is given by a negative number

Methods List

canDel () Returns true if the object could be deleted (is not used)
GenerationHintFlag () Returns the value of GenerationHintFlag property
GenerationHintValueMax () Returns the value of GenerationHintValueMax property
GenerationHintValueMin () Returns the value of GenerationHintValueMin property
getCompareTypeCode () Returns code of comparation type for threshold value of aggregational quantifiers, see CompareType codes
getCompareTypeKey () Returns unique string key of comparation type for threshold value of aggregational quantifiers
getCompareTypeName () Returns string representation of comparation type for threshold value of aggregational quantifiers
getFromCol () Returns the value of FromCol property
getFromRow () Returns the value of FromRow property
getID () Returns unique identifier (primary key) of the object
getKLQuantifierTypeCode () Returns code of quantifier type for this quantifier, see KLQuantifierType codes
getKLQuantifierTypeKey () Returns unique string key of quantifier type for this quantifier
getKLQuantifierTypeName () Returns string representation of quantifier type for this quantifier
getKLQuantifierValueTypeCode () Returns code of absolute/relative type threshold value of aggregational quantifiers, see KLQuantifierValueType codes
getKLQuantifierValueTypeKey () Returns unique string key of absolute/relative type threshold value of aggregational quantifiers
getKLQuantifierValueTypeName () Returns string representation of absolute/relative type threshold value of aggregational quantifiers
getNote () Returns the value of Note property
getOrder () Returns the value of Order property
getTaskKL () Returns the TaskKL, the task this quantifier setting belongs to
getThresholdValue () Returns the value of ThresholdValue property
getToCol () Returns the value of ToCol property
getToRow () Returns the value of ToRow property
isKendallTauBAbsValueFlag () Returns the value of KendallTauBAbsValueFlag property
onAdd () Store the newly created object into metabase
onDel () Delete the object from metabase (fails if canDel returns false)
onUpdate () Save changes made to the object into metabase
setCompareTypeCode () Sets code of comparation type for threshold value of aggregational quantifiers, see CompareType codes
setFromCol () Sets the value of FromCol property
setFromRow () Sets the value of FromRow property
setKendallTauBAbsValueFlag () Sets the value of KendallTauBAbsValueFlag property
setKLQuantifierTypeCode () Sets code of quantifier type for this quantifier, see KLQuantifierType codes
setKLQuantifierValueTypeCode () Sets code of absolute/relative type threshold value of aggregational quantifiers, see KLQuantifierValueType codes
setNote () Sets the value of Note property
setOrder () Sets the value of Order property
setThresholdValue () Sets the value of ThresholdValue property
setToCol () Sets the value of ToCol property
setToRow () Sets the value of ToRow property

Properties

FromCol : integer
Absolute or relative index of the leKL boundary of range for columns. Relative position is given by a negative number
FromRow : integer
Absolute or relative index of the leKL boundary of range for rows. Relative position is given by a negative number
GenerationHintFlag  (read-only) : boolean
If there are available hints from the last task run
GenerationHintValueMax  (read-only) : float
Hint from the last task run - the lowest found interest measure for this quantifier
GenerationHintValueMin  (read-only) : float
Hint from the last task run - the lowest found interest measure for this quantifier
ID  (read-only) : integer
Unique identifier (primary key) of the object
Intherited from: LMWrap
KendallTauBAbsValueFlag : boolean
Whether the Kendall's coefficient TauB values should be in positive interval only, e.g. <0;1>
Note : string
Additional note to this partial cedent
Order : integer
Order-index of this partial cedent in array of partial cedent of its TaskKL
RangeRelFlag  (read-only) : boolean
If the range for rows and cols is specified in percentage form
ThresholdValue : float
KL-Quantifiers threshold value
ToCol : integer
Absolute or relative index of the right boundary of range for columns. Relative position is given by a negative number
ToRow : integer
Absolute or relative index of the right boundary of range for rows. Relative position is given by a negative number

Methods

canDel() : boolean
Returns true if the object could be deleted (is not used)
Intherited from: LMWrap

Returns

  • boolean
GenerationHintFlag() : boolean
Returns the value of GenerationHintFlag property

Returns

  • boolean
GenerationHintValueMax() : float
Returns the value of GenerationHintValueMax property

Returns

  • float
GenerationHintValueMin() : float
Returns the value of GenerationHintValueMin property

Returns

  • float
getCompareTypeCode() : integer
Returns code of comparation type for threshold value of aggregational quantifiers, see CompareType codes

Returns

  • integer
getCompareTypeKey() : string
Returns unique string key of comparation type for threshold value of aggregational quantifiers

Returns

  • string
getCompareTypeName() : string
Returns string representation of comparation type for threshold value of aggregational quantifiers

Returns

  • string
getFromCol() : integer
Returns the value of FromCol property

Returns

  • integer
getFromRow() : integer
Returns the value of FromRow property

Returns

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

Returns

  • integer
getKLQuantifierTypeCode() : integer
Returns code of quantifier type for this quantifier, see KLQuantifierType codes

Returns

  • integer
getKLQuantifierTypeKey() : string
Returns unique string key of quantifier type for this quantifier

Returns

  • string
getKLQuantifierTypeName() : string
Returns string representation of quantifier type for this quantifier

Returns

  • string
getKLQuantifierValueTypeCode() : integer
Returns code of absolute/relative type threshold value of aggregational quantifiers, see KLQuantifierValueType codes

Returns

  • integer
getKLQuantifierValueTypeKey() : string
Returns unique string key of absolute/relative type threshold value of aggregational quantifiers

Returns

  • string
getKLQuantifierValueTypeName() : string
Returns string representation of absolute/relative type threshold value of aggregational quantifiers

Returns

  • string
getNote() : string
Returns the value of Note property

Returns

  • string
getOrder() : integer
Returns the value of Order property

Returns

  • integer
getTaskKL() : TaskKL
Returns the TaskKL, the task this quantifier setting belongs to

Returns

getThresholdValue() : float
Returns the value of ThresholdValue property

Returns

  • float
getToCol() : integer
Returns the value of ToCol property

Returns

  • integer
getToRow() : integer
Returns the value of ToRow property

Returns

  • integer
isKendallTauBAbsValueFlag() : boolean
Returns the value of KendallTauBAbsValueFlag property

Returns

  • boolean
onAdd()
Store the newly created object into metabase
Intherited from: LMWrap
onDel()
Delete the object from metabase (fails if canDel returns false)
Intherited from: LMWrap
onUpdate()
Save changes made to the object into metabase
Intherited from: LMWrap
setCompareTypeCode( integer )
Sets code of comparation type for threshold value of aggregational quantifiers, see CompareType codes

Parameters

  • integer
setFromCol( integer )
Sets the value of FromCol property

Parameters

  • integer
setFromRow( integer )
Sets the value of FromRow property

Parameters

  • integer
setKendallTauBAbsValueFlag( boolean )
Sets the value of KendallTauBAbsValueFlag property

Parameters

  • boolean
setKLQuantifierTypeCode( integer )
Sets code of quantifier type for this quantifier, see KLQuantifierType codes

Parameters

  • integer
setKLQuantifierValueTypeCode( integer )
Sets code of absolute/relative type threshold value of aggregational quantifiers, see KLQuantifierValueType codes

Parameters

  • integer
setNote( string )
Sets the value of Note property

Parameters

  • string
setOrder( integer )
Sets the value of Order property

Parameters

  • integer
setThresholdValue( float )
Sets the value of ThresholdValue property

Parameters

  • float
setToCol( integer )
Sets the value of ToCol property

Parameters

  • integer
setToRow( integer )
Sets the value of ToRow property

Parameters

  • integer