HierarchicalClusterCollection Class

Represents a collection of clusters.

Definition

Namespace: Numerics.NET.Statistics.Multivariate
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.4

public class HierarchicalClusterCollection : List<HierarchicalCluster>

Visual Basic

Public Class HierarchicalClusterCollection
	Inherits List(Of HierarchicalCluster)

C++/CLI

public ref class HierarchicalClusterCollection : public List<HierarchicalCluster^>

type HierarchicalClusterCollection = 
    class
        inherit List<HierarchicalCluster>
    end

Inheritance: Object → List<HierarchicalCluster> → HierarchicalClusterCollection

Remarks

Use the HierarchicalClusterCollection class to access the collection of HierarchicalCluster objects produced by a hierarchical clustering procedure computed by the HierarchicalClusterAnalysis class. Once a cluster hierarchy has been computed, the GetClusterPartition(Int32) method can be used to partition the observation into the specified number of clusters.

This collection is read-only. The HierarchicalCluster objects it contains are also read-only.

Properties

Capacity	Gets or sets the total number of elements the internal data structure can hold without resizing. (Inherited from List<HierarchicalCluster>)
Count	Gets the number of elements contained in the List<T>. (Inherited from List<HierarchicalCluster>)
Item	Gets or sets the element at the specified index. (Inherited from List<HierarchicalCluster>)

Methods

Add	Adds an object to the end of the List<T>. (Inherited from List<HierarchicalCluster>)
AddRange	Adds the elements of the specified collection to the end of the List<T>. (Inherited from List<HierarchicalCluster>)
AsReadOnly	Returns a read-only ReadOnlyCollection<T> wrapper for the current collection. (Inherited from List<HierarchicalCluster>)
BinarySearch(T)	Searches the entire sorted List<T> for an element using the default comparer and returns the zero-based index of the element. (Inherited from List<HierarchicalCluster>)
BinarySearch(T, IComparer<T>)	Searches the entire sorted List<T> for an element using the specified comparer and returns the zero-based index of the element. (Inherited from List<HierarchicalCluster>)
BinarySearch(Int32, Int32, T, IComparer<T>)	Searches a range of elements in the sorted List<T> for an element using the specified comparer and returns the zero-based index of the element. (Inherited from List<HierarchicalCluster>)
Clear	Removes all elements from the List<T>. (Inherited from List<HierarchicalCluster>)
Contains	Determines whether an element is in the List<T>. (Inherited from List<HierarchicalCluster>)
ConvertAll<TOutput>	Converts the elements in the current List<T> to another type, and returns a list containing the converted elements. (Inherited from List<HierarchicalCluster>)
CopyTo(T[])	Copies the entire List<T> to a compatible one-dimensional array, starting at the beginning of the target array. (Inherited from List<HierarchicalCluster>)
CopyTo(T[], Int32)	Copies the entire List<T> to a compatible one-dimensional array, starting at the specified index of the target array. (Inherited from List<HierarchicalCluster>)
CopyTo(Int32, T[], Int32, Int32)	Copies a range of elements from the List<T> to a compatible one-dimensional array, starting at the specified index of the target array. (Inherited from List<HierarchicalCluster>)
EnsureCapacity	Ensures that the capacity of this list is at least the specified capacity. If the current capacity is less than capacity, it is increased to at least the specified capacity. (Inherited from List<HierarchicalCluster>)
Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
Exists	Determines whether the List<T> contains elements that match the conditions defined by the specified predicate. (Inherited from List<HierarchicalCluster>)
Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
Find	Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the entire List<T>. (Inherited from List<HierarchicalCluster>)
FindAll	Retrieves all the elements that match the conditions defined by the specified predicate. (Inherited from List<HierarchicalCluster>)
FindIndex(Predicate<T>)	Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire List<T>. (Inherited from List<HierarchicalCluster>)
FindIndex(Int32, Predicate<T>)	Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the List<T> that extends from the specified index to the last element. (Inherited from List<HierarchicalCluster>)
FindIndex(Int32, Int32, Predicate<T>)	Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the List<T> that starts at the specified index and contains the specified number of elements. (Inherited from List<HierarchicalCluster>)
FindLast	Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire List<T>. (Inherited from List<HierarchicalCluster>)
FindLastIndex(Predicate<T>)	Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire List<T>. (Inherited from List<HierarchicalCluster>)
FindLastIndex(Int32, Predicate<T>)	Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the List<T> that extends from the first element to the specified index. (Inherited from List<HierarchicalCluster>)
FindLastIndex(Int32, Int32, Predicate<T>)	Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the List<T> that contains the specified number of elements and ends at the specified index. (Inherited from List<HierarchicalCluster>)
ForEach	Performs the specified action on each element of the List<T>. (Inherited from List<HierarchicalCluster>)
GetEnumerator	Returns an enumerator that iterates through the List<T>. (Inherited from List<HierarchicalCluster>)
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetMemberships	Returns the cluster memberships as a CategoricalVector<T>.
GetRange	Creates a shallow copy of a range of elements in the source List<T>. (Inherited from List<HierarchicalCluster>)
GetType	Gets the Type of the current instance. (Inherited from Object)
IndexOf(T)	Searches for the specified object and returns the zero-based index of the first occurrence within the entire List<T>. (Inherited from List<HierarchicalCluster>)
IndexOf(T, Int32)	Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the List<T> that extends from the specified index to the last element. (Inherited from List<HierarchicalCluster>)
IndexOf(T, Int32, Int32)	Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the List<T> that starts at the specified index and contains the specified number of elements. (Inherited from List<HierarchicalCluster>)
Insert	Inserts an element into the List<T> at the specified index. (Inherited from List<HierarchicalCluster>)
InsertRange	Inserts the elements of a collection into the List<T> at the specified index. (Inherited from List<HierarchicalCluster>)
LastIndexOf(T)	Searches for the specified object and returns the zero-based index of the last occurrence within the entire List<T>. (Inherited from List<HierarchicalCluster>)
LastIndexOf(T, Int32)	Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the List<T> that extends from the first element to the specified index. (Inherited from List<HierarchicalCluster>)
LastIndexOf(T, Int32, Int32)	Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the List<T> that contains the specified number of elements and ends at the specified index. (Inherited from List<HierarchicalCluster>)
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
Remove	Removes the first occurrence of a specific object from the List<T>. (Inherited from List<HierarchicalCluster>)
RemoveAll	Removes all the elements that match the conditions defined by the specified predicate. (Inherited from List<HierarchicalCluster>)
RemoveAt	Removes the element at the specified index of the List<T>. (Inherited from List<HierarchicalCluster>)
RemoveRange	Removes a range of elements from the List<T>. (Inherited from List<HierarchicalCluster>)
Reverse()	Reverses the order of the elements in the entire List<T>. (Inherited from List<HierarchicalCluster>)
Reverse(Int32, Int32)	Reverses the order of the elements in the specified range. (Inherited from List<HierarchicalCluster>)
Slice	Creates a shallow copy of a range of elements in the source List<T>. (Inherited from List<HierarchicalCluster>)
Sort()	Sorts the elements in the entire List<T> using the default comparer. (Inherited from List<HierarchicalCluster>)
Sort(Comparison<T>)	Sorts the elements in the entire List<T> using the specified Comparison<T>. (Inherited from List<HierarchicalCluster>)
Sort(IComparer<T>)	Sorts the elements in the entire List<T> using the specified comparer. (Inherited from List<HierarchicalCluster>)
Sort(Int32, Int32, IComparer<T>)	Sorts the elements in a range of elements in List<T> using the specified comparer. (Inherited from List<HierarchicalCluster>)
ToArray	Copies the elements of the List<T> to a new array. (Inherited from List<HierarchicalCluster>)
ToString	Returns a string that represents the current object. (Inherited from Object)
TrimExcess	Sets the capacity to the actual number of elements in the List<T>, if that number is less than a threshold value. (Inherited from List<HierarchicalCluster>)
TrueForAll	Determines whether every element in the List<T> matches the conditions defined by the specified predicate. (Inherited from List<HierarchicalCluster>)

HierarchicalClusterCollection Class

Definition

Remarks

Properties

Methods

See Also

Reference