/*
  This file is part of the BJP package.

  BJP package is free software: you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by the
  Free Software Foundation, either version 3 of the License, or (at your
  option) any later version.

  BJP package 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 Lesser General Public
  License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with BJP package.  If not, see <http://www.gnu.org/licenses/>.
 */
package learn.struct.scoring;

import rep.UndirectedGraph;
import dataset.Dataset;
import dataset.adtree.ADNode;

/**
 * @author fschluter
 * 
 */
public interface GraphScorable {

	
	/**
	 * Computes the score of an undirected graph from an ADTree cache
	 * @param g
	 * @param dataset
	 * @return
	 */
	public UndirectedGraphScore computeScore(UndirectedGraph g, Dataset dataset);
	
	/**
	 * Computes the score of an undirected graph from a dataset, 
	 * using the information of a structure whose score has benn computed before, 
	 * in order to save computational costs.
	 * @param g
	 * @param incremental
	 * @param dataset
	 * @return
	 */
	public UndirectedGraphScore computeScore(UndirectedGraph g, UndirectedGraphScore incremental, Dataset dataset);

	
	/**
	 * 
	 * Computes the score of an undirected graph from a dataset
	 * 
	 * @param g
	 * @param test
	 * @param dataset
	 * @param adTree 
	 * @param useADTree 
	 * @return
	 */
	public UndirectedGraphScore computeScore(UndirectedGraph g, Dataset dataset, boolean useADTree, ADNode adTree);

	/**
	 * Returns a name or key string that identifies the scoring function
	 * @return
	 */
	public String getScoringFunctionName();

	
}
