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

Class weka.attributeSelection.BestFirst

java.lang.Object
   |
   +----weka.attributeSelection.ASSearch
           |
           +----weka.attributeSelection.BestFirst

public class BestFirst
extends ASSearch
implements OptionHandler, StartSetHandler
Class for performing a best first search.

Valid options are:

-P
Specify a starting set of attributes. Eg 1,4,7-9.

-D <-1 = backward | 0 = bidirectional | 1 = forward>
Direction of the search. (default = 1).

-N
Number of non improving nodes to consider before terminating search. (default = 5).

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

Variable Index

 o TAGS_SELECTION

Constructor Index

 o BestFirst()
Constructor

Method Index

 o getDirection()
Get the search direction
 o getOptions()
Gets the current settings of BestFirst.
 o getSearchTermination()
Get the termination criterion (number of non-improving nodes).
 o getStartSet()
Returns a list of attributes (and or attribute ranges) as a String
 o listOptions()
Returns an enumeration describing the available options
 o search(ASEvaluation, Instances)
Searches the attribute subset space by best first search
 o setDirection(SelectedTag)
Set the search direction
 o setOptions(String[])
Parses a given list of options.
 o setSearchTermination(int)
Set the numnber of non-improving nodes to consider before terminating search.
 o setStartSet(String)
Sets a starting set of attributes for the search.
 o toString()
returns a description of the search as a String

Variables

 o TAGS_SELECTION
 public static final Tag TAGS_SELECTION[]

Constructors

 o BestFirst
 public BestFirst()
Constructor

Methods

 o listOptions
 public Enumeration listOptions()
Returns an enumeration describing the available options

Returns:
an enumeration of all the available options
 o setOptions
 public void setOptions(String options[]) throws Exception
Parses a given list of options. Valid options are:

-P
Specify a starting set of attributes. Eg 1,4,7-9.

-D <-1 = backward | 0 = bidirectional | 1 = forward>
Direction of the search. (default = 1).

-N
Number of non improving nodes to consider before terminating search. (default = 5).

Parameters:
options - the list of options as an array of strings
Throws: Exception
if an option is not supported
 o setStartSet
 public void setStartSet(String startSet) throws Exception
Sets a starting set of attributes for the search. It is the search method's responsibility to report this start set (if any) in its toString() method.

Parameters:
startSet - a string containing a list of attributes (and or ranges), eg. 1,2,6,10-15.
Throws: if
start set can't be set.
 o getStartSet
 public String getStartSet()
Returns a list of attributes (and or attribute ranges) as a String

Returns:
a list of attributes (and or attribute ranges)
 o setSearchTermination
 public void setSearchTermination(int t) throws Exception
Set the numnber of non-improving nodes to consider before terminating search.

Parameters:
t - the number of non-improving nodes
Throws: Exception
if t is less than 1
 o getSearchTermination
 public int getSearchTermination()
Get the termination criterion (number of non-improving nodes).

Returns:
the number of non-improving nodes
 o setDirection
 public void setDirection(SelectedTag d)
Set the search direction

Parameters:
d - the direction of the search
 o getDirection
 public SelectedTag getDirection()
Get the search direction

Returns:
the direction of the search
 o getOptions
 public String[] getOptions()
Gets the current settings of BestFirst.

Returns:
an array of strings suitable for passing to setOptions()
 o toString
 public String toString()
returns a description of the search as a String

Returns:
a description of the search
Overrides:
toString in class Object
 o search
 public int[] search(ASEvaluation ASEval,
                     Instances data) throws Exception
Searches the attribute subset space by best first search

Parameters:
ASEvaluator - the attribute evaluator to guide the search
data - the training instances.
Returns:
an array (not necessarily ordered) of selected attribute indexes
Throws: Exception
if the search can't be completed
Overrides:
search in class ASSearch

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