|
KDTree Class |
Convenience class for k-dimensional tree static methods. To
create a new KDTree, specify the generic parameter as in
KDTreeT.
Inheritance HierarchySystemObject
Accord.CollectionsBinaryTreeKDTreeNode
Accord.CollectionsKDTreeBaseKDTreeNode
Accord.CollectionsKDTree
Accord.CollectionsBinaryTreeKDTreeNode
Accord.CollectionsKDTreeBaseKDTreeNode
Accord.CollectionsKDTree
Namespace: Accord.Collections
Assembly: Accord.MachineLearning (in Accord.MachineLearning.dll) Version: 3.8.0
SyntaxThe KDTree type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | KDTree(Int32) |
Creates a new KDTree.
|
| KDTree(Int32, KDTreeNode) |
Creates a new KDTree.
|
| KDTree(Int32, KDTreeNode, Int32, Int32) |
Creates a new KDTree.
|
Properties| Name | Description | |
|---|---|---|
 | Count |
Gets the number of elements contained in this
tree. This is also the number of tree nodes.
(Inherited from KDTreeBaseTNode.) |
| Dimensions |
Gets the number of dimensions expected
by the input points of this tree.
(Inherited from KDTreeBaseTNode.) |
| Distance |
Gets or set the distance function used to
measure distances amongst points on this tree
(Inherited from KDTreeBaseTNode.) |
| Leaves |
Gets the number of leaves contained in this
tree. This can be used to calibrate approximate
nearest searchers.
(Inherited from KDTreeBaseTNode.) |
| Root |
Gets the root node of this tree.
(Inherited from BinaryTreeTNode.) |
Methods| Name | Description | |
|---|---|---|
| Add |
Adds a new point to this tree.
|
 | AddNode |
Inserts a value into the tree at the desired position.
(Inherited from KDTreeBaseTNode.) |
| ApproximateNearest(Double, Double) |
Retrieves a percentage of nearest points to a given point.
(Inherited from KDTreeBaseTNode.) |
| ApproximateNearest(Double, Int32) |
Retrieves a fixed number of nearest points to a given point.
(Inherited from KDTreeBaseTNode.) |
| ApproximateNearest(Double, Double, Double) |
Retrieves a percentage of nearest points to a given point.
(Inherited from KDTreeBaseTNode.) |
| ApproximateNearest(Double, Int32, Double) |
Retrieves a fixed percentage of nearest points to a given point.
(Inherited from KDTreeBaseTNode.) |
| ApproximateNearest(Double, Int32, Int32) |
Retrieves a fixed number of nearest points to a given point.
(Inherited from KDTreeBaseTNode.) |
| Clear |
Removes all nodes from this tree.
(Inherited from KDTreeBaseTNode.) |
| CopyTo |
Copies the entire tree to a compatible one-dimensional Array, starting
at the specified arrayIndex of the array.
(Inherited from KDTreeBaseTNode.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
 | FromData(Double, Boolean) |
Creates a new k-dimensional tree from the given points.
|
| FromData(Double, IMetricDouble, Boolean) |
Creates a new k-dimensional tree from the given points.
|
| FromDataT(Double, Boolean) |
Creates a new k-dimensional tree from the given points.
|
| FromDataT(Double, IMetricDouble, Boolean) |
Creates a new k-dimensional tree from the given points.
|
| FromDataT(Double, T, Boolean) |
Creates a new k-dimensional tree from the given points.
|
| FromDataT(Double, T, IMetricDouble, Boolean) |
Creates a new k-dimensional tree from the given points.
|
| GetEnumerator |
Returns an enumerator that iterates through the tree.
(Inherited from BinaryTreeTNode.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetNodesInsideRegion |
Retrieves a list of all points inside a given region.
(Inherited from KDTreeBaseTNode.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Nearest(Double) |
Retrieves the nearest point to a given point.
(Inherited from KDTreeBaseTNode.) |
| Nearest(Double, Double) |
Retrieves the nearest points to a given point within a given radius.
(Inherited from KDTreeBaseTNode.) |
| Nearest(Double, Double) |
Retrieves the nearest point to a given point.
(Inherited from KDTreeBaseTNode.) |
| Nearest(Double, Int32) |
Retrieves a fixed number of nearest points to a given point.
(Inherited from KDTreeBaseTNode.) |
| Nearest(Double, Double, Int32) |
Retrieves the nearest points to a given point within a given radius.
(Inherited from KDTreeBaseTNode.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Traverse |
Traverse the tree using a tree traversal
method. Can be iterated with a foreach loop.
(Inherited from BinaryTreeTNode.) |
Extension Methods| Name | Description | |
|---|---|---|
 | HasMethod |
Checks whether an object implements a method with the given name.
(Defined by ExtensionMethods.) |
| IsEqual |
Compares two objects for equality, performing an elementwise
comparison if the elements are vectors or matrices.
(Defined by Matrix.) |
| To(Type) | Overloaded.
Converts an object into another type, irrespective of whether
the conversion can be done at compile time or not. This can be
used to convert generic types to numeric types during runtime.
(Defined by ExtensionMethods.) |
| ToT | Overloaded.
Converts an object into another type, irrespective of whether
the conversion can be done at compile time or not. This can be
used to convert generic types to numeric types during runtime.
(Defined by ExtensionMethods.) |
Remarks
Please check the documentation page for KDTreeT
for examples, usage and actual remarks about kd-trees.
See Also