AggregateKMeansResponse (Kinetica Java API 7.1.10.4 API)

java.lang.Object
- com.gpudb.protocol.AggregateKMeansResponse

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
```
public class AggregateKMeansResponse
extends Object
implements org.apache.avro.generic.IndexedRecord
```
A set of results returned by GPUdb.aggregateKMeans(AggregateKMeansRequest).

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AggregateKMeansResponse.Info
Additional information.

Nested Classes
Modifier and Type	Class and Description
`static class`	`AggregateKMeansResponse.Info` Additional information.

Constructor Summary

Constructors
Constructor and Description

AggregateKMeansResponse()
Constructs an AggregateKMeansResponse object with default parameters.

Constructors
Constructor and Description
`AggregateKMeansResponse()` Constructs an AggregateKMeansResponse object with default parameters.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Object`	`get(int index)` This method supports the Avro framework and is not intended to be called directly by the user.
`static org.apache.avro.Schema`	`getClassSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`long`	`getCount()`
`List<Long>`	`getCounts()`
`Map<String,String>`	`getInfo()`
`List<List<Double>>`	`getMeans()`
`int`	`getNumIters()`
`double`	`getRmsDist()`
`List<Double>`	`getRmsDists()`
`org.apache.avro.Schema`	`getSchema()` This method supports the Avro framework and is not intended to be called directly by the user.
`double`	`getTolerance()`
`int`	`hashCode()`
`void`	`put(int index, Object value)` This method supports the Avro framework and is not intended to be called directly by the user.
`AggregateKMeansResponse`	`setCount(long count)`
`AggregateKMeansResponse`	`setCounts(List<Long> counts)`
`AggregateKMeansResponse`	`setInfo(Map<String,String> info)`
`AggregateKMeansResponse`	`setMeans(List<List<Double>> means)`
`AggregateKMeansResponse`	`setNumIters(int numIters)`
`AggregateKMeansResponse`	`setRmsDist(double rmsDist)`
`AggregateKMeansResponse`	`setRmsDists(List<Double> rmsDists)`
`AggregateKMeansResponse`	`setTolerance(double tolerance)`
`String`	`toString()`

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

- Constructor Detail
  - AggregateKMeansResponse
```
public AggregateKMeansResponse()
```
    Constructs an AggregateKMeansResponse object with default parameters.
- Method Detail
  - getClassSchema
```
public static org.apache.avro.Schema getClassSchema()
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Returns:
    
    the schema for the class.
  - getMeans
```
public List<List<Double>> getMeans()
```
    Returns:
    
    The k-mean values found.
  - setMeans
```
public AggregateKMeansResponse setMeans(List<List<Double>> means)
```
    Parameters:
    
    means - The k-mean values found.
    
    Returns:
    
    this to mimic the builder pattern.
  - getCounts
```
public List<Long> getCounts()
```
    Returns:
    
    The number of elements in the cluster closest the corresponding k-means values.
  - setCounts
```
public AggregateKMeansResponse setCounts(List<Long> counts)
```
    Parameters:
    
    counts - The number of elements in the cluster closest the corresponding k-means values.
    
    Returns:
    
    this to mimic the builder pattern.
  - getRmsDists
```
public List<Double> getRmsDists()
```
    Returns:
    
    The root mean squared distance of the elements in the cluster for each of the k-means values.
  - setRmsDists
```
public AggregateKMeansResponse setRmsDists(List<Double> rmsDists)
```
    Parameters:
    
    rmsDists - The root mean squared distance of the elements in the cluster for each of the k-means values.
    
    Returns:
    
    this to mimic the builder pattern.
  - getCount
```
public long getCount()
```
    Returns:
    
    The total count of all the clusters - will be the size of the input table.
  - setCount
```
public AggregateKMeansResponse setCount(long count)
```
    Parameters:
    
    count - The total count of all the clusters - will be the size of the input table.
    
    Returns:
    
    this to mimic the builder pattern.
  - getRmsDist
```
public double getRmsDist()
```
    Returns:
    
    The sum of all the rms_dists - the value the k-means algorithm is attempting to minimize.
  - setRmsDist
```
public AggregateKMeansResponse setRmsDist(double rmsDist)
```
    Parameters:
    
    rmsDist - The sum of all the rms_dists - the value the k-means algorithm is attempting to minimize.
    
    Returns:
    
    this to mimic the builder pattern.
  - getTolerance
```
public double getTolerance()
```
    Returns:
    
    The distance between the last two iterations of the algorithm before it quit.
  - setTolerance
```
public AggregateKMeansResponse setTolerance(double tolerance)
```
    Parameters:
    
    tolerance - The distance between the last two iterations of the algorithm before it quit.
    
    Returns:
    
    this to mimic the builder pattern.
  - getNumIters
```
public int getNumIters()
```
    Returns:
    
    The number of iterations the algorithm executed before it quit.
  - setNumIters
```
public AggregateKMeansResponse setNumIters(int numIters)
```
    Parameters:
    
    numIters - The number of iterations the algorithm executed before it quit.
    
    Returns:
    
    this to mimic the builder pattern.
  - getInfo
```
public Map<String,String> getInfo()
```
    Returns:
    Additional information.
    
    QUALIFIED_RESULT_TABLE_NAME: The fully qualified name of the result table (i.e. including the schema) used to store the results.
    The default value is an empty Map.
  - setInfo
```
public AggregateKMeansResponse setInfo(Map<String,String> info)
```
    Parameters:
    info - Additional information.
    
    QUALIFIED_RESULT_TABLE_NAME: The fully qualified name of the result table (i.e. including the schema) used to store the results.
    The default value is an empty Map.
    Returns:
    
    this to mimic the builder pattern.
  - getSchema
```
public org.apache.avro.Schema getSchema()
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Specified by:
    
    getSchema in interface org.apache.avro.generic.GenericContainer
    
    Returns:
    
    the schema object describing this class.
  - get
```
public Object get(int index)
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Specified by:
    
    get in interface org.apache.avro.generic.IndexedRecord
    
    Parameters:
    
    index - the position of the field to get
    
    Returns:
    
    value of the field with the given index.
    
    Throws:
    
    IndexOutOfBoundsException
  - put
```
public void put(int index,
                Object value)
```
    This method supports the Avro framework and is not intended to be called directly by the user.
    
    Specified by:
    
    put in interface org.apache.avro.generic.IndexedRecord
    
    Parameters:
    
    index - the position of the field to set
    
    value - the value to set
    
    Throws:
    
    IndexOutOfBoundsException
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class AggregateKMeansResponse

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AggregateKMeansResponse

Method Detail

getClassSchema

getMeans

setMeans

getCounts

setCounts

getRmsDists

setRmsDists

getCount

setCount

getRmsDist

setRmsDist

getTolerance

setTolerance

getNumIters

setNumIters

getInfo

setInfo

getSchema

get

put

equals

toString

hashCode