 | |
ClusterTInstance Class | |
Represents a set of TInstance elements arranged in a hierarchical form.
Inheritance HierarchyNamespace: Aglomera
Assembly: Aglomera (in Aglomera.dll) Version: 1.1.0
SyntaxC#
public class Cluster<TInstance> : IEnumerable<TInstance>, IEnumerable, IEquatable<Cluster<TInstance>>, IComparable<Cluster<TInstance>> where TInstance : Object, IComparable<TInstance>
Type Parameters
- TInstance
- The type of instance considered.
The ClusterTInstance type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ClusterTInstance(ClusterTInstance) |
Creates a new ClusterTInstance which is an exact copy of the given cluster.
|
| ClusterTInstance(IEnumerableTInstance, Double) |
Creates a new ClusterTInstance with the given TInstance elements.
|
| ClusterTInstance(TInstance, Double) |
Creates a new ClusterTInstance with a single TInstance element.
|
| ClusterTInstance(ClusterTInstance, ClusterTInstance, Double) |
Creates a new ClusterTInstance by joining the two given clusters.
|
Properties| Name | Description | |
|---|---|---|
 | Count |
Gets the number of elements in this cluster.
|
| Dissimilarity |
Gets the dissimilarity / distance at which this cluster was found by the clustering algorithm.
|
| Parent1 |
Gets this cluster's first parent, if the cluster was formed by joining two existing clusters. Otherwise returns
null.
|
| Parent2 |
Gets this cluster's second parent, if the cluster was formed by joining two existing clusters. Otherwise returns
null.
|
Methods| Name | Description | |
|---|---|---|
| Clone |
Creates a new ClusterTInstance which is an exact copy of this cluster.
|
| CompareTo |
Compares this cluster with another cluster instance. Comparison is performed by count (number of items) first, then
by string representation of the items.
|
| Contains |
Checks whether this cluster contains the given item.
|
| Equals(Object) | (Overrides ObjectEquals(Object).) |
| Equals(ClusterTInstance) |
Checks whether this cluster is equal to another. Equality between cluster occurs when they are the same object or
when the clusters contain the same elements, were created based on the same parent clusters and have the same
associated dissimilarity.
|
 | Finalize | (Inherited from Object.) |
| GetEnumerator | |
| GetHashCode | (Overrides ObjectGetHashCode.) |
| GetType | (Inherited from Object.) |
| MemberwiseClone | (Inherited from Object.) |
| ToString |
Gets a string representing this cluster in the form (item1;item2;...;itemN).
(Overrides ObjectToString.) |
Fields
Extension Methods| Name | Description | |
|---|---|---|
 | GetMedoidTInstance |
Returns the medoid of a given ClusterTInstance, i.e., a representative object whose dissimilarity
to all the instances in the cluster is minimal.
(Defined by Extensions.) |
See Also