KDTreeNodeCollectionTNode Class

Collection of k-dimensional tree nodes.

Inheritance Hierarchy

SystemObject
Accord.CollectionsKDTreeNodeCollectionTNode

Namespace: Accord.Collections
Assembly: Accord.MachineLearning (in Accord.MachineLearning.dll) Version: 3.8.0

Syntax

Copy

[SerializableAttribute]
public class KDTreeNodeCollection<TNode> : IEnumerable
where TNode : KDTreeNodeBase<TNode>, IComparable<TNode>, IEquatable<TNode>

<SerializableAttribute>
Public Class KDTreeNodeCollection(Of TNode As {KDTreeNodeBase(Of TNode), IComparable(Of TNode), IEquatable(Of TNode)})
	Implements IEnumerable

Request Example View Source

Type Parameters

TNode: The class type for the nodes of the tree.

The KDTreeNodeCollectionTNode type exposes the following members.

Constructors

	Name	Description
	KDTreeNodeCollectionTNode	Creates a new KDTreeNodeCollectionTNode with a maximum size.

Top

Properties

	Name	Description
	Capacity	Gets or sets the maximum number of elements on this collection, if specified. A value of zero indicates this instance has no upper limit of elements.
	Count	Gets the number of elements in this collection.
	Farthest	Gets the farthest node in the collection (with greatest distance).
	IsReadOnly	Gets a value indicating whether this instance is read only. For this collection, always returns false.
	Item	Gets the NodeDistanceTNode at the specified index. Note: this method will iterate over the entire collection until the given position is found.
	Maximum	Gets the maximum distance between a node in this collection and the query point.
	Minimum	Gets the minimum distance between a node in this collection and the query point.
	Nearest	Gets the nearest node in the collection (with smallest distance).

Top

Methods

	Name	Description
	Add(NodeDistanceTNode)	Adds the specified item to this collection.
	Add(TNode, Double)	Attempts to add a value to the collection. If the list is full and the value is more distant than the farthest node in the collection, the value will not be added.
	AddFarthest	Attempts to add a value to the collection. If the list is full and the value is more distant than the farthest node in the collection, the value will not be added.
	Clear	Removes all elements from this collection.
	Contains	Determines whether this instance contains the specified item.
	CopyTo	Copies the entire collection to a compatible one-dimensional Array, starting at the specified arrayIndex of the array.
	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.)
	GetEnumerator	Returns an enumerator that iterates through this collection.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Remove	Not supported.
	RemoveFarthest	Removes the farthest tree node from this collection.
	RemoveNearest	Removes the nearest tree node from this collection.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

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.)
	SetEqualsNodeDistanceTNode	Compares two enumerables for set equality. Two enumerables are set equal if they contain the same elements, but not necessarily in the same order. (Defined by Matrix.)
	SortedNodeDistanceTNode	Sorts the elements of an entire one-dimensional array using the given comparison. (Defined by Vector.)
	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.)

Top

Remarks

This class is used to store neighbor nodes when running one of the search algorithms for k-dimensional trees.

Reference

Accord.Collections Namespace

Accord.CollectionsKDTreeT

Accord.CollectionsNodeDistanceTNode

KDTreeNodeCollectionAddLanguageSpecificTextSet("LST1A21D0BF_0?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");TNodeAddLanguageSpecificTextSet("LST1A21D0BF_1?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)"); Class

Type Parameters

Reference

KDTreeNodeCollectionTNode Class