AssociationRule.java

/***********************************************************************

	This file is part of KEEL-software, the Data Mining tool for regression, 
	classification, clustering, pattern mining and so on.

	Copyright (C) 2004-2010
	
	F. Herrera (herrera@decsai.ugr.es)
    L. S�nchez (luciano@uniovi.es)
    J. Alcal�-Fdez (jalcala@decsai.ugr.es)
    S. Garc�a (sglopez@ujaen.es)
    A. Fern�ndez (alberto.fernandez@ujaen.es)
    J. Luengo (julianlm@decsai.ugr.es)

	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 http://www.gnu.org/licenses/
  
**********************************************************************/

package keel.Algorithms.UnsupervisedLearning.AssociationRules.IntervalRuleLearning.GAR;

import java.util.*;


public class AssociationRule
{
  private ArrayList<Gene> antecedent;
  private ArrayList<Gene> consequent;
  private double all_support;
  private double support_ant;
  private double support_cons;
  private double confidence;
  private double lift;
  private double conv;
  private double CF;
  private double netConf; 
  private double yulesQ;
  
  
  public AssociationRule()
  {
    this.antecedent = new ArrayList<Gene>();
    this.consequent = new ArrayList<Gene>();
  }

  public AssociationRule copy () {
	int i;
	AssociationRule rule = new AssociationRule();

	for (i=0; i < this.antecedent.size(); i++) {
		rule.addAntecedent((this.antecedent.get(i)).copy());
	}

	for (i=0; i < this.consequent.size(); i++) {
		rule.addConsequent((this.consequent.get(i)).copy());
	}
	
	rule.all_support = this.all_support;
	rule.support_ant = this.support_ant;
	rule.support_cons = this.support_cons;
	rule.confidence = this.confidence;
	rule.lift = this.lift;
	rule.CF = this.CF;
	rule.conv = this.conv;
	rule.netConf = this.netConf;
	rule.yulesQ = this.yulesQ;
	return (rule);
  } 
  
  public void sortGenes (ArrayList<Gene> genes) {
		int i, j;
		Gene gen;

		for (i=0; i <genes.size()-1; i++) {
			for (j=0; j <genes.size()-i-1; j++) {
				if (genes.get(j).getAttr() > genes.get(j+1).getAttr()) {
					gen = genes.get(j);
					genes.set(j, genes.get(j+1));
					genes.set(j+1,gen);
				}
			}
		}
	}

  public ArrayList<Gene> getGenesRule(){
	  ArrayList<Gene> genesRule = new ArrayList<>();
	  int i;
	  
	  for (i=0; i < this.antecedent.size(); i++) {
		 genesRule.add((this.antecedent.get(i)).copy());
	  }

	  for (i=0; i < this.consequent.size(); i++) {
		  genesRule.add((this.consequent.get(i)).copy());
	  }
	  
	  
	  return genesRule;
  }
  public void addAntecedent(Gene g)
  {
    antecedent.add(g);
  }
  
  
  public void addConsequent(Gene g)
  {
    consequent.add(g);
  }
  
  
  public ArrayList<Gene> getAntecedent()
  {
    return this.antecedent;
  }
  
  
  public ArrayList<Gene> getConsequent()
  {
    return this.consequent;
  }

  public int getLength () {
    return (this.antecedent.size() + this.consequent.size());
  }

  public int getLengthAnt () {
    return (this.antecedent.size());
  }


  public double getAll_support()
  {
	return all_support;
  }


  public void setAll_support(double all_support)
  {
	this.all_support = all_support;
  }

  public double getSupport_Ant() {
	return this.support_ant;
  }


  public void setSupport_Ant(double support) {
	this.support_ant = support;
  }


  public double getConfidence()
  {
	return confidence;
  }


  public void setConfidence(double confidence)
  {
	this.confidence = confidence;
  }
  
   
  public String toString()
  {
	return ( this.antecedent.toString() + "-> " + this.consequent.toString() + ": " + this.getSupport_Ant() + "; " + this.getAll_support() + "; " + this.getConfidence());
  }

	/**
	 * <p>
	 * It returns the CF of an association rule
	 * </p>
	 * @return A value representing the CF of the association rule
	 */
	public double getCF() {
		return CF;
	}
	
	/**
	 * <p>
	 * It sets the CF of an association rule
	 * </p>
	 * @param cf The value representing the rule cf
	 */
	public void setCF(double cf) {
		CF = cf;
	}
	
	/**
	 * <p>
	 * It returns the conviction of an association rule
	 * </p>
	 * @return A value representing the conviction of the association rule
	 */
	public double getConv() {
		return conv;
	}
	
	/**
	 * <p>
	 * It sets the conviction of an association rule
	 * </p>
	 * @param conv The value representing the rule conviction
	 */
	public void setConv(double conv) {
		this.conv = conv;
	}

	/**
	 * <p>
	 * It returns the netconf of an association rule
	 * </p>
	 * @return A value representing the netconf of the association rule
	 */
	public double getNetConf() {
		return netConf;
	}
	
	/**
	 * <p>
	 * It sets the netconf of an association rule
	 * </p>
	 * @param netconf The value representing the rule netconf
	 */
	public void setNetConf(double netConf) {
		this.netConf = netConf;
	}

	/**
	 * <p>
	 * It returns the consequent support of an association rule
	 * </p>
	 * @return A value representing the consequent support of the association rule
	 */
    public double getSupport_cons() {
	   return support_cons;
    }

	/**
	 * <p>
	 * It sets the consequent support of an association rule
	 * </p>
	 * @param consequentSupport The value representing the rule consequent support 
	 */
    public void setSupport_cons(double support_cons) {
    	this.support_cons = support_cons;
    }

	/**
	 * <p>
	 * It returns the yulesQ of an association rule
	 * </p>
	 * @return A value representing the yulesQ of the association rule
	 */
	public double getYulesQ() {
		return yulesQ;
	}
	/**
	 * <p>
	 * It sets the yulesQ of an association rule
	 * </p>
	 * @param yulesQ The value representing the rule yulesQ
	 */
	public void setYulesQ(double yulesQ) {
		this.yulesQ = yulesQ;
	}

	/**
	 * <p>
	 * It returns the lift of an association rule
	 * </p>
	 * @return A value representing the lift of the association rule
	 */
	public double getLift() {
		return lift;
	}
	/**
	 * <p>
	 * It sets the lift of an association rule
	 * </p>
	 * @param lift The value representing the rule lift
	 */
	public void setLift(double lift) {
		this.lift = lift;
	}




}