Batch Processing
Algorithm Input
Input ID

Input
 

data 
Pointer to the
n
x 2 numeric table t with the mining data. Each row consists of two integers:
The input can be an object of any class derived from
NumericTable
except
PackedTriangularMatrix
and
PackedSymmetricMatrix
.

Algorithm Parameters
Parameter

Default Value

Description


algorithmFPType 
float 
The floatingpoint type that the algorithm uses for intermediate computations. Can be
float
or
double
.

method 
defaultDense 
The computation method used by the algorithm. The only method supported so far is Apriori.

minSupport 
0.01

Minimal support, a number in the [0,1) interval.

minConfidence

0.6

Minimal confidence, a number in the [0,1) interval.

nUniqueItems 
0

The total number of unique items. If set to zero, the library automatically determines the number of unique items from the input data.

nTransactions 
0

The total number of transactions. If set to zero, the library automatically determines the number transactions from the input data.

discoverRules 
true 
A flag that enables generation of the rules from large item sets.

itemsetsOrder 
itemsetsUnsorted 
The sort order of returned item sets:

rulesOrder 
rulesUnsorted 
The sort order of returned rules:

minItemsetSize 
0

A parameter that defines the minimal size of item sets to be included into the array of results. The value of zero imposes no limitations on the minimal size of item sets.

maxItemsetSize 
0

A parameter that defines the maximal size of item sets to be included into the array of results. The value of zero imposes no limitations on the maximal size of item sets.

Algorithm Output
Result ID

Result
 

largeItemsets 
Pointer to the numeric table with large item sets. The number of rows in the table equals the number of items in the large item sets. Each row contains two integers:
By default, this result is an object of the
HomogenNumericTable
class, but you can define the result as an object of any class derived from
NumericTable
except
PackedSymmetricMatrix
,
PackedTriangularMatrix
, and
СSRNumericTable
.
 
largeItemsetsSupport 
Pointer to the
nLargeItemsets
x 2 numeric table of support values. Each row contains two integers:
By default, this result is an object of the
HomogenNumericTable
class, but you can define the result as an object of any class derived from
NumericTable
except
PackedSymmetricMatrix
,
PackedTriangularMatrix
, and
СSRNumericTable
.
 
antecedentItemsets 
Pointer to the
nAntecedentItems
x 2 numeric table that contains the lefthandside (
X
) part of the association rules. Each row contains two integers:
By default, this result is an object of the
HomogenNumericTable
class, but you can define the result as an object of any class derived from
NumericTable
except
PackedSymmetricMatrix
,
PackedTriangularMatrix
, and
СSRNumericTable
.
 
conseqentItemsets 
Pointer to the
nConsequentItems
x 2 numeric table that contains the righthandside (
Y
) part of the association rules. Each row contains two integers:
By default, this result is an object of the
HomogenNumericTable
class, but you can define the result as an object of any class derived from
NumericTable
except
PackedSymmetricMatrix
,
PackedTriangularMatrix
, and
СSRNumericTable
.
 
confidence 
Pointer to the
nRules
x 1 numeric table that contains confidence values of rules, floatingpoint numbers between 0 and 1. Confidence value in the
i
th position corresponds to the rule with the index
i
.
By default, this result is an object of the
HomogenNumericTable
class, but you can define the result as an object of any class derived from
NumericTable
except
PackedSymmetricMatrix
,
PackedTriangularMatrix
, and
СSRNumericTable
.

 The library requires transactions and items for each transaction to be passed in the ascending order.
 Numbering of rules starts at 0.
 The library calculates the sizes of numeric tables intended for results in a call to the algorithm. Avoid allocating the memory in numeric tables intended for results because, in general, it is impossible to accurately estimate the required memory size. If the memory interfaced by the numeric tables is allocated and its amount is insufficient to store the results, the algorithm returns an error.