io.gitlab.chaver.mining.rules.measure.RuleMeasure Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of data-mining Show documentation

Data mining with Choco solver

There is a newer version: 1.0.1

/*
 * This file is part of io.gitlab.chaver:data-mining (https://gitlab.com/chaver/data-mining)
 *
 * Copyright (c) 2022, IMT Atlantique
 *
 * Licensed under the MIT license.
 *
 * See LICENSE file in the project root for full license information.
 */
package io.gitlab.chaver.mining.rules.measure;

import io.gitlab.chaver.mining.rules.io.IRule;

/**
 * Measure to compute for an association rule
 */
public interface RuleMeasure {

    /**
     * Name of the measure
     * @return the name of the measure
     */
    String getName();

    /**
     * Compute the measure
     * @param rule given association rule
     * @param nbTransactions number of transactions in the database
     * @return the value of the measure for this association rule
     */
    double compute(IRule rule, int nbTransactions);
}