| Package | flare.analytics.cluster |
| Class | public class AgglomerativeCluster |
| Inheritance | AgglomerativeCluster HierarchicalCluster Operator |
DataSprite
instances and returns a Number.
This class supports both minimum-link clustering, in which the distance between clusters is measured as the distance between the two nearest items in each cluster, and maximum-link clustering, in which distance is measured using the two furthest items in each cluster.
For a richer description, see the Wikipedia article on Cluster Analysis.
| Property | Defined by | ||
|---|---|---|---|
![]() | clusterField : String The property in which to store cluster indices.
| HierarchicalCluster | |
![]() | clusterTree : Tree
The cluster tree of detected community structures.
| HierarchicalCluster | |
![]() | criteria : Array Computed criterion values for each merge in the cluster tree.
| HierarchicalCluster | |
| distance : Function = null A function defining distances between items.
| AgglomerativeCluster | ||
![]() | enabled : Boolean Indicates if the operator is enabled or disabled.
| Operator | |
![]() | group : String The data group to cluster.
| HierarchicalCluster | |
| minLink : Boolean = true If true, minimum-link distances are computed between clusters.
| AgglomerativeCluster | ||
![]() | parameters : Object
Sets parameter values for this operator.
| Operator | |
![]() | sequenceField : String The property in which to store sequence indices.
| HierarchicalCluster | |
![]() | visualization : Visualization
The visualization processed by this operator.
| Operator | |
| Method | Defined by | ||
|---|---|---|---|
|
AgglomerativeCluster(group:String)
Creates a new agglomerative cluster instance
| AgglomerativeCluster | ||
![]() |
applyParameters(op:IOperator, params:Object):void
[static]
Static method that applies parameter settings to an operator.
| Operator | |
|
Calculates the community structure clustering.
| AgglomerativeCluster | ||
![]() |
labelNodes(merge:int = -1):void
Labels nodes with their cluster membership, determined by
the given merge number.
| HierarchicalCluster | |
|
operate(t:Transitioner = null):void
Performs an operation over the contents of a visualization.
| AgglomerativeCluster | ||
![]() |
setup():void
Setup method invoked whenever this operator's visualization
property is set.
| Operator | |
| distance | property |
public var distance:Function = nullA function defining distances between items.
| minLink | property |
public var minLink:Boolean = trueIf true, minimum-link distances are computed between clusters. If false, maximum-link distances are computed between clusters.
| AgglomerativeCluster | () | constructor |
public function AgglomerativeCluster(group:String)Creates a new agglomerative cluster instance
Parametersgroup:String |
| calculate | () | method |
public function calculate(list:DataList, d:Function):voidCalculates the community structure clustering. As a result of this method, a cluster tree will be computed and graph nodes will be annotated with both community and sequence indices.
Parameterslist:DataList — a data list to cluster
|
|
d:Function — a distance function
|
| operate | () | method |
public override function operate(t:Transitioner = null):voidPerforms an operation over the contents of a visualization.
Parameterst:Transitioner (default = null) — a Transitioner instance for collecting value updates.
|