IDAX.PRUNE_SEQRULES - Prune sequential patterns

Use this stored procedure to prune the patterns and rules of a sequential patterns model.

To remove patterns or rules that you are not interested in, you can use filters to exclude these patterns or rules. These patterns or rules are then marked as not valid in the model and are no longer shown.

Authorization

The privileges held by the authorization ID of the statement must include the IDAX_USER role. Additionally, you must be the owner of the model or have the authority to alter it.

Syntax

IDAX.PRUNE_SEQRULES(in parameter_string varchar(32672))

Parameter descriptions

parameter_string
Mandatory one-string parameter that contains pairs of <parameter>=<value> entries that are separated by a comma.
Data type: VARCHAR(32672)
The following list shows the parameter values:
model
Mandatory.
The name of the sequential patterns model that is to be pruned.
Data type: VARCHAR(192)
itemsin
Optional.
A list of item names that must be contained in the patterns or rules to be kept. The items are separated by semicolons. At least one of the listed items must be contained in a pattern or rule to be kept.
Default: none
For rules, the following conditions apply:
  • To indicate that the item must be contained in the head of the rule, the item names can be succeeded by :h or :head.
  • To indicate that the item must be contained in the body of the rule, the item names can be succeeded by :b or :body
Data type: VARCHAR(32000)
If this parameter is not specified, no constraint is applied.
itemsout
Optional.
A list of item names that must not be contained in the patterns or rules to be kept. The items are separated by semicolons.
Default: none
Data type: VARCHAR(32000)
If this parameter is not specified, no constraint is applied.
minlen
Optional.
The minimum number of items per pattern or rule according to which the pattern or rule is pruned.
Default: 1
Range: >= 1 and <= maxlen
Data type: INTEGER
maxlen
Optional.
The maximum number of items per pattern or rule according to which the pattern or rule is pruned.
Default: the longest sequential pattern of the model
Range: >= minlen
Data type: INTEGER
minsupport
Optional.
The minimum support for the patterns or rules that are to be kept.
Default: 0.0
Range: >=0.0 and <=maxsupport
Data type: DOUBLE
maxsupport
Optional.
The maximum support for the patterns or rules that are to be kept.
Default: 1.0
Range: >=minsupport and <=1.0
Data type: DOUBLE
minlift
Optional.
The minimum lift of the patterns or rules that are to be kept.
Default: 0.0
Range: >=0.0 and <=maxlift
Data type: DOUBLE
maxlift
Optional.
The maximum lift of the patterns or rules that are to be kept.
Default: the maximum lift of the sequential patterns of the model
Range: >=minlift
Data type: DOUBLE
minconf
Optional.
The minimum confidence of the rules that are to be kept.
Default: 0.0
Data type: DOUBLE
Range: >=0.0 and <= maxconf
maxconf
Optional.
The maximum confidence of the rules that are to be kept.
Default: 1.0
Data type: DOUBLE
Range: >=minconf and <= 1.0
mintime
Optional.
The minimum time between the body and the head of the rules that are to be kept.
Default: 0.0
Data type: INTERVAL or DOUBLE
Range: >=0.0 and <= maxtime
maxtime
Optional.
The maximum time between the body and the head of the rules that are to be kept.
Default: The maximum relative time of the rules of the model
Data type: INTERVAL or DOUBLE
Range: >=mintime
reset
Optional.
Default: false
Data type: BOOLEAN
If you specify reset=true, all sequential patterns and rules are first reset to not pruned.
If you specify reset=true or reset=false, the rules and patterns that are not to be kept are marked as pruned.

Returned information

The number of rules that are kept after the pruning process as a result set. The model tables are modified.

Example

CALL IDAX.PRUNE_SEQRULES('model=retail_seqrules, minlen=3');