GvmResult (HM Gears 0.10.7 API)

java.lang.Object
- org.hortonmachine.gears.utils.clustering.GvmResult<K>

Type Parameters:

K - the key type
```
public class GvmResult<K>
extends Object
```
A snapshot of a cluster that has been produced as the result of clustering a number of coordinates.

Author:

Tom Gibara

Constructor Summary

Constructors
Constructor Description

GvmResult()
Creates an empty result object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getCount()`	The number of points in the cluster.
`K`	`getKey()`	The key associated with the cluster.
`double`	`getMass()`	The aggregate mass of the cluster.
`Object`	`getPoint()`	The coordinates of the cluster's centroid.
`GvmSpace`	`getSpace()`
`double`	`getStdDeviation()`	The standard deviation of the cluster.
`double`	`getVariance()`	The variance of the cluster.
`void`	`setCount(int count)`
`void`	`setKey(K key)`	Sets the key associated with the cluster.
`void`	`setMass(double mass)`	Sets the aggregate mass of the cluster.
`void`	`setPoint(Object point)`	Sets the coordinates of the cluster's centroid.
`void`	`setSpace(GvmSpace space)`
`void`	`setVariance(double variance)`	Sets the variance of the cluster.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GvmResult
```
public GvmResult()
```
    Creates an empty result object
- Method Detail
  - getCount
```
public int getCount()
```
    The number of points in the cluster.
  - setCount
```
public void setCount(int count)
```
  - getMass
```
public double getMass()
```
    The aggregate mass of the cluster.
  - setMass
```
public void setMass(double mass)
```
    Sets the aggregate mass of the cluster.
  - getSpace
```
public GvmSpace getSpace()
```
  - setSpace
```
public void setSpace(GvmSpace space)
```
  - getPoint
```
public Object getPoint()
```
    The coordinates of the cluster's centroid. The returned array should not be modified.
  - setPoint
```
public void setPoint(Object point)
```
    Sets the coordinates of the cluster's centroid. The values of the supplied point are copied.
  - getVariance
```
public double getVariance()
```
    The variance of the cluster.
  - getStdDeviation
```
public double getStdDeviation()
```
    The standard deviation of the cluster.
  - setVariance
```
public void setVariance(double variance)
```
    Sets the variance of the cluster.
  - getKey
```
public K getKey()
```
    The key associated with the cluster.
  - setKey
```
public void setKey(K key)
```
    Sets the key associated with the cluster.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object