|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectweka.core.neighboursearch.NearestNeighbourSearch
weka.core.neighboursearch.LinearNNSearch
public class LinearNNSearch
Class implementing the brute force search algorithm for nearest neighbour search.
Valid options are:-S Skip identical instances (distances equal to zero).
| Constructor Summary | |
|---|---|
LinearNNSearch()
Constructor. |
|
LinearNNSearch(Instances insts)
Constructor that uses the supplied set of instances. |
|
| Method Summary | |
|---|---|
void |
addInstanceInfo(Instance ins)
Adds the given instance info. |
double[] |
getDistances()
Returns the distances of the k nearest neighbours. |
java.lang.String[] |
getOptions()
Gets the current settings. |
java.lang.String |
getRevision()
Returns the revision string. |
boolean |
getSkipIdentical()
Gets whether if identical instances are skipped from the neighbourhood. |
java.lang.String |
globalInfo()
Returns a string describing this nearest neighbour search algorithm. |
Instances |
kNearestNeighbours(Instance target,
int kNN)
Returns k nearest instances in the current neighbourhood to the supplied instance. |
java.util.Enumeration |
listOptions()
Returns an enumeration describing the available options. |
Instance |
nearestNeighbour(Instance target)
Returns the nearest instance in the current neighbourhood to the supplied instance. |
void |
setInstances(Instances insts)
Sets the instances comprising the current neighbourhood. |
void |
setOptions(java.lang.String[] options)
Parses a given list of options. |
void |
setSkipIdentical(boolean skip)
Sets the property to skip identical instances (with distance zero from the target) from the set of neighbours returned. |
java.lang.String |
skipIdenticalTipText()
Returns the tip text for this property. |
void |
update(Instance ins)
Updates the LinearNNSearch to cater for the new added instance. |
| Methods inherited from class weka.core.neighboursearch.NearestNeighbourSearch |
|---|
combSort11, distanceFunctionTipText, enumerateMeasures, getDistanceFunction, getInstances, getMeasure, getMeasurePerformance, getPerformanceStats, measurePerformanceTipText, quickSort, setDistanceFunction, setMeasurePerformance |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public LinearNNSearch()
public LinearNNSearch(Instances insts)
insts - the instances to use| Method Detail |
|---|
public java.lang.String globalInfo()
globalInfo in class NearestNeighbourSearchpublic java.util.Enumeration listOptions()
listOptions in interface OptionHandlerlistOptions in class NearestNeighbourSearch
public void setOptions(java.lang.String[] options)
throws java.lang.Exception
-S Skip identical instances (distances equal to zero).
setOptions in interface OptionHandlersetOptions in class NearestNeighbourSearchoptions - the list of options as an array of strings
java.lang.Exception - if an option is not supportedpublic java.lang.String[] getOptions()
getOptions in interface OptionHandlergetOptions in class NearestNeighbourSearchpublic java.lang.String skipIdenticalTipText()
public void setSkipIdentical(boolean skip)
skip - if true, identical intances are skippedpublic boolean getSkipIdentical()
public Instance nearestNeighbour(Instance target)
throws java.lang.Exception
nearestNeighbour in class NearestNeighbourSearchtarget - The instance to find the nearest neighbour for.
java.lang.Exception - if the nearest neighbour could not be found.
public Instances kNearestNeighbours(Instance target,
int kNN)
throws java.lang.Exception
kNearestNeighbours in class NearestNeighbourSearchtarget - The instance to find the k nearest neighbours for.kNN - The number of nearest neighbours to find.
java.lang.Exception - if the neighbours could not be found.
public double[] getDistances()
throws java.lang.Exception
getDistances in class NearestNeighbourSearchjava.lang.Exception - if called before calling kNearestNeighbours
or nearestNeighbours.
public void setInstances(Instances insts)
throws java.lang.Exception
setInstances in class NearestNeighbourSearchinsts - The set of instances on which the nearest neighbour
search is carried out. Usually this set is the
training set.
java.lang.Exception - if setting of instances fails
public void update(Instance ins)
throws java.lang.Exception
update in class NearestNeighbourSearchins - The instance to add. Usually this is the instance that
is added to our neighbourhood i.e. the training
instances.
java.lang.Exception - if the given instances are nullpublic void addInstanceInfo(Instance ins)
addInstanceInfo in class NearestNeighbourSearchins - The instance to add the information of. Usually this is
the test instance supplied to update the range of
attributes in the distance function.public java.lang.String getRevision()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||