de.mrapp.apriori.modules.AssociationRuleGenerator.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of apriori Show documentation

A Java implementation of the Apriori algorithm for finding frequent item sets and (optionally) generating association rules.

The newest version!

/*
 * Copyright 2017 - 2019 Michael Rapp
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
package de.mrapp.apriori.modules

import de.mrapp.apriori.Item
import de.mrapp.apriori.ItemSet
import de.mrapp.apriori.RuleSet

/**
 * Defines the interface, a class, which allows to generate association rules, must implement.
 *
 * @param ItemType The type of the items, which are processed by the algorithm
 * @author Michael Rapp
 * @since 1.0.0
 */
interface AssociationRuleGenerator {

    /**
     * Generates association rules from frequent item sets.
     *
     * @param frequentItemSets A map, which contains all available frequent item sets. The map must
     *                         store the frequent item sets as values and their hash codes as the
     *                         corresponding keys
     * @param minConfidence    The minimum confidence, which must at least be reached by association
     *                         rules. The confidence must be at least 0 and at maximum 1
     * @return A rule set, which contains the association rules, which have been generated
     */
    fun generateAssociationRules(frequentItemSets: Map>,
                                 minConfidence: Double): RuleSet

}