All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home

Interface weka.attributeSelection.RankedOutputSearch

public interface RankedOutputSearch
Interface for search methods capable of producing a ranked list of attributes.

Version:
$Revision 1.1 $
Author:
Mark Hall (mhall@cs.waikato.ac.nz)

Method Index

o getGenerateRanking()
Gets whether the user has opted to see a ranked list of attributes rather than the normal result of the search
o getThreshold()
Gets the threshold by which attributes can be discarded.
o rankedAttributes()
Returns a X by 2 list of attribute indexes and corresponding evaluations from best (highest) to worst.
o setGenerateRanking(boolean)
Sets whether or not ranking is to be performed.
o setThreshold(double)
Sets a threshold by which attributes can be discarded from the ranking.

Methods

o rankedAttributes 
 public abstract double[][] rankedAttributes() throws Exception
Returns a X by 2 list of attribute indexes and corresponding evaluations from best (highest) to worst.

Returns:
the ranked list of attribute indexes in an array of ints
Throws: Exception
if the ranking can't be produced
o setThreshold 
 public abstract void setThreshold(double threshold)
Sets a threshold by which attributes can be discarded from the ranking. This threshold is used by the AttributeSelection module which does the actual discarding of attributes---the implementer of this method needs only to provide a variable in which to store the supplied threshold.

Parameters:
threshold - the threshold.
o getThreshold 
 public abstract double getThreshold()
Gets the threshold by which attributes can be discarded. Discarding of attributes is done by the AttributeSelection module using the threshold returned by this method.

Returns:
a threshold by which to discard attributes
o setGenerateRanking 
 public abstract void setGenerateRanking(boolean doRanking)
Sets whether or not ranking is to be performed. When a search method is capable of producing a ranked list of attributes, the user has the choice of seeing the results of a normal search or seeing a ranked list.

Parameters:
doRanking - true if ranked list is to be produced
o getGenerateRanking 
 public abstract boolean getGenerateRanking()
Gets whether the user has opted to see a ranked list of attributes rather than the normal result of the search

Returns:
true if a ranked list has been requested. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home