Click or drag to resize

ClusterSet Class

Class ClusterSet represents a collection of objects assigned to a finite number of clusters.
Inheritance Hierarchy
SystemObject
  CenterSpace.NMath.CoreClusterSet

Namespace: CenterSpace.NMath.Core
Assembly: NMath (in NMath.dll) Version: 7.4
Syntax
[SerializableAttribute]
public class ClusterSet : IEnumerable, ICloneable

The ClusterSet type exposes the following members.

Properties
 NameDescription
Public propertyClusters Gets an array of integers that identifies the cluster into which each object is grouped.
Public propertyItem Gets the cluster to which the given object is assigned.
Public propertyN Gets the number of objects clustered in this cluster set.
Public propertyNumberOfClusters Gets the number of clusters into which objects are grouped.
Top
Methods
 NameDescription
Public methodClone Creates a deep copy of this cluster set.
Public methodCluster Returns the objects assigned to a given cluster.
Public methodEquals Tests for equality of this cluster set and another. Two cluster sets are equal if they have the same number of objects and all objects are assigned to the same clusters.
(Overrides ObjectEquals(Object))
Public methodGetEnumerator Creates an IEnumerator out of the clusters in this set.
Public methodGetHashCode Returns an integer hash code for this cluster set.
(Overrides ObjectGetHashCode)
Public methodOnDeserialized Update following deserialization
Public methodToString Returns a formatted string representation of this cluster set.
(Overrides ObjectToString)
Top
Operators
 NameDescription
Public operatorStatic memberEquality(ClusterSet, ClusterSet) Tests for equality of two cluster sets. Two clusters sets are equal if they have the same number of objects and all objects are assigned to the same clusters.
Public operatorStatic member(ClusterSet to Int32) Implicitly converts a cluster set into an array of integers.
Public operatorStatic memberInequality(ClusterSet, ClusterSet) Tests for inequality of two cluster sets. Two cluster sets are unequal if they have different numbers of objects or the objects are assigned to different clusters.
Top
Remarks
Instances of class ClusterSet are returned by the ClusterAnalysis.CutTree() method and cannot be constructed independently.
The Clusters property returns an array of integers that identifies the cluster into which each object was grouped. Cluster numbers are arbitrary, and range from 0 to NumberOfClusters - 1. The indexer gets the cluster to which a given object is assigned. The Cluster() method returns the objects assigned to a given cluster.
See Also