Libraries.Compute.Statistics.Clustering.ClusterResult Documentation

The ClusterResult class represents the output of a clustering algorithm. Overall, it provides two key pieces. First, it provides the clusters themselves as a selection of points (in this case, class Vector). This provides a way to conduct calculations directly on the set of points. Second, it provides an IntegerColumn with cluster assignments to the original DataFrame. The purpose of this is to make it easy to add this column back to the frame, either for calculations or for charts.

Inherits from: Libraries.Language.Object

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

Example

use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)

GetClusterIndices()

Returns the assignment between the cluster index and individual points. This can be used as a factor in a future calculation or chart.

Return

Libraries.Compute.Statistics.Columns.IntegerColumn:

GetClusters()

Returns the clusters themselves.

Return

Libraries.Containers.Array:

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

SetClusterIndices(Libraries.Compute.Statistics.Columns.IntegerColumn clusterIndices)

Sets the assignment between the cluster index and individual points. This can be used as a factor in a future calculation or chart.

Parameters

SetClusters(Libraries.Containers.Array<Libraries.Compute.Statistics.Clustering.Cluster> clusters)

Sets the clusters themselves.

Parameters