weka.associations.CARuleMiner Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of weka-dev Show documentation

The Waikato Environment for Knowledge Analysis (WEKA), a machine learning workbench. This version represents the developer version, the "bleeding edge" of development, you could say. New functionality gets added to this version.

There is a newer version: 3.9.6

Show newest version

/*
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see .
 */

/*
 * CARuleMiner.java
 * Copyright (C) 2004-2012 University of Waikato, Hamilton, New Zealand
 *
 */

package weka.associations;

import java.util.ArrayList;

import weka.core.Instances;
import weka.core.OptionHandler;

/**
 * Interface for learning class association rules. All schemes for learning
 * class association rules implemement this interface.
 * 
 * @author Stefan Mutter ([email protected])
 * @version $Revision: 10172 $
 */
public interface CARuleMiner extends OptionHandler {

  /**
   * Method for mining class association rules. Must initialize all fields of
   * the CARuleMiner that are not being set via options (ie. multiple calls of
   * mineCARs must always lead to the same result). Must not change the dataset
   * in any way.
   * 
   * @param data the insatnces for which class association rules are mined
   * @throws Exception throws exception if class association rules cannot be
   *           mined
   * @return class association rules and their scoring metric in an FastVector
   *         array
   */
  public ArrayList