> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.AggregateKMeansRequest > kinetica.AggregateKMeansRequest — Kinetica C# API

A set of parameters for Kinetica.aggregateKMeans. More...

Inheritance diagram for kinetica.AggregateKMeansRequest:
Collaboration diagram for kinetica.AggregateKMeansRequest:

Classes
struct   Options
  A set of string constants for the parameter AggregateKMeansRequest.options. More...
 

Public Member Functions
  AggregateKMeansRequest ()
  Constructs an AggregateKMeansRequest object with default parameters.
 
  AggregateKMeansRequest (string table\_name, IList\< string > column\_names, int k, double tolerance, IDictionary\< string, string > options=null)
  Constructs an AggregateKMeansRequest object with the specified parameters.
 
  AggregateKMeansRequest ()
  Constructs an AggregateKMeansRequest object with default parameters.
 
  AggregateKMeansRequest (string table\_name, IList\< string > column\_names, int k, double tolerance, IDictionary\< string, string > options=null)
  Constructs an AggregateKMeansRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 
  KineticaData (KineticaType type)
  Constructor from Kinetica Type.
 
  KineticaData (System.Type type=null)
  Default constructor, with optional System.Type.
 
object  Get (int fieldPos)
  Retrieve a specific property from this object.
 
void  Put (int fieldPos, object fieldValue)
  Write a specific property to this object.
 

Properties
string  table\_name \[get, set]
  Name of the table on which the operation will be performed.
 
IList\< string >  column\_names = new List\() \[get, set]
  List of column names on which the operation would be performed.
 
int  k \[get, set]
  The number of mean points to be determined by the algorithm.
 
double  tolerance \[get, set]
  Stop iterating when the distances between successive points is less than the given tolerance.
 
IDictionary\< string, string >  options = new Dictionary\() \[get, set]
  Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema  Schema \[get]
  Avro Schema for this class.
 

Additional Inherited Members
 Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 
static ? RecordSchema  SchemaFromType (System.Type t, KineticaType? ktype=null)
  Create an Avro Schema from a System.Type and a KineticaType.
 

Detailed Description

A set of parameters for Kinetica.aggregateKMeans.

This endpoint runs the k-means algorithm - a heuristic algorithm that attempts to do k-means clustering. An ideal k-means clustering algorithm selects k points such that the sum of the mean squared distances of each member of the set to the nearest of the k points is minimized. The k-means algorithm however does not necessarily produce such an ideal cluster. It begins with a randomly selected set of k points and then refines the location of the points iteratively and settles to a local minimum. Various parameters and options are provided to control the heuristic search.

NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service this request.

Definition at line 25 of file AggregateKMeans.cs.

Constructor & Destructor Documentation

◆ AggregateKMeansRequest() \[1/4]

kinetica.AggregateKMeansRequest.AggregateKMeansRequest ( )
inline

Constructs an AggregateKMeansRequest object with default parameters.

Definition at line 273 of file AggregateKMeans.cs.

◆ AggregateKMeansRequest() \[2/4]

kinetica.AggregateKMeansRequest.AggregateKMeansRequest ( string table\_name,
IList\< string > column\_names,
int k,
double tolerance,
IDictionary\< string, string > options = null )
inline

Constructs an AggregateKMeansRequest object with the specified parameters.

Parameters
table\_name Name of the table on which the operation will be performed. Must be an existing table, in \[schema\_name.]table\_name format, using standard name resolution rules.
column\_names List of column names on which the operation would be performed. If n columns are provided then each of the k result points will have n dimensions corresponding to the n columns.
k The number of mean points to be determined by the algorithm.
tolerance Stop iterating when the distances between successive points is less than the given tolerance.
options Optional parameters.
  • WHITEN: When set to 1 each of the columns is first normalized by its stdv - default is not to whiten.
  • MAX\_ITERS: Number of times to try to hit the tolerance limit before giving up - default is 10.
  • NUM\_TRIES: Number of times to run the k-means algorithm with a different randomly selected starting points - helps avoid local minimum. Default is 1.
  • CREATE\_TEMP\_TABLE: If TRUE, a unique temporary table name will be generated in the sys\_temp schema and used in place of RESULT\_TABLE. If RESULT\_TABLE\_PERSIST is FALSE (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED\_RESULT\_TABLE\_NAME. Supported values: The default value is FALSE.
  • RESULT\_TABLE: The name of a table used to store the results, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. If this option is specified, the results are not returned in the response.
  • RESULT\_TABLE\_PERSIST: If TRUE, then the result table specified in RESULT\_TABLE will be persisted and will not expire unless a TTL is specified. If FALSE, then the result table will be an in-memory table and will expire unless a TTL is specified otherwise. Supported values: The default value is FALSE.
  • TTL: Sets the TTL of the table specified in RESULT\_TABLE.
The default value is an empty Dictionary.

Definition at line 404 of file AggregateKMeans.cs.

◆ AggregateKMeansRequest() \[3/4]

kinetica.AggregateKMeansRequest.AggregateKMeansRequest ( )
inline

Constructs an AggregateKMeansRequest object with default parameters.

Definition at line 273 of file AggregateKMeans.cs.

◆ AggregateKMeansRequest() \[4/4]

kinetica.AggregateKMeansRequest.AggregateKMeansRequest ( string table\_name,
IList\< string > column\_names,
int k,
double tolerance,
IDictionary\< string, string > options = null )
inline

Constructs an AggregateKMeansRequest object with the specified parameters.

Parameters
table\_name Name of the table on which the operation will be performed. Must be an existing table, in \[schema\_name.]table\_name format, using standard name resolution rules.
column\_names List of column names on which the operation would be performed. If n columns are provided then each of the k result points will have n dimensions corresponding to the n columns.
k The number of mean points to be determined by the algorithm.
tolerance Stop iterating when the distances between successive points is less than the given tolerance.
options Optional parameters.
  • WHITEN: When set to 1 each of the columns is first normalized by its stdv - default is not to whiten.
  • MAX\_ITERS: Number of times to try to hit the tolerance limit before giving up - default is 10.
  • NUM\_TRIES: Number of times to run the k-means algorithm with a different randomly selected starting points - helps avoid local minimum. Default is 1.
  • CREATE\_TEMP\_TABLE: If TRUE, a unique temporary table name will be generated in the sys\_temp schema and used in place of RESULT\_TABLE. If RESULT\_TABLE\_PERSIST is FALSE (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED\_RESULT\_TABLE\_NAME. Supported values: The default value is FALSE.
  • RESULT\_TABLE: The name of a table used to store the results, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. If this option is specified, the results are not returned in the response.
  • RESULT\_TABLE\_PERSIST: If TRUE, then the result table specified in RESULT\_TABLE will be persisted and will not expire unless a TTL is specified. If FALSE, then the result table will be an in-memory table and will expire unless a TTL is specified otherwise. Supported values: The default value is FALSE.
  • TTL: Sets the TTL of the table specified in RESULT\_TABLE.
The default value is an empty Dictionary.

Definition at line 404 of file AggregateKMeans.cs.

Property Documentation

◆ column\_names

IList\< string > kinetica.AggregateKMeansRequest.column\_names = new List\()
getset

List of column names on which the operation would be performed.

If n columns are provided then each of the k result points will have n dimensions corresponding to the n columns.

Definition at line 145 of file AggregateKMeans.cs.

◆ k

int kinetica.AggregateKMeansRequest.k
getset

The number of mean points to be determined by the algorithm.

Definition at line 149 of file AggregateKMeans.cs.

◆ options

IDictionary\< string, string > kinetica.AggregateKMeansRequest.options = new Dictionary\()
getset

Optional parameters.

  • WHITEN: When set to 1 each of the columns is first normalized by its stdv - default is not to whiten.
  • MAX\_ITERS: Number of times to try to hit the tolerance limit before giving up - default is 10.
  • NUM\_TRIES: Number of times to run the k-means algorithm with a different randomly selected starting points - helps avoid local minimum. Default is 1.
  • CREATE\_TEMP\_TABLE: If TRUE, a unique temporary table name will be generated in the sys\_temp schema and used in place of RESULT\_TABLE. If RESULT\_TABLE\_PERSIST is FALSE (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED\_RESULT\_TABLE\_NAME. Supported values: The default value is FALSE.
  • RESULT\_TABLE: The name of a table used to store the results, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. If this option is specified, the results are not returned in the response.
  • RESULT\_TABLE\_PERSIST: If TRUE, then the result table specified in RESULT\_TABLE will be persisted and will not expire unless a TTL is specified. If FALSE, then the result table will be an in-memory table and will expire unless a TTL is specified otherwise. Supported values: The default value is FALSE.
  • TTL: Sets the TTL of the table specified in RESULT\_TABLE.

The default value is an empty Dictionary.

Definition at line 269 of file AggregateKMeans.cs.

◆ table\_name

string kinetica.AggregateKMeansRequest.table\_name
getset

Name of the table on which the operation will be performed.

Must be an existing table, in \[schema\_name.]table\_name format, using standard name resolution rules.

Definition at line 138 of file AggregateKMeans.cs.

◆ tolerance

double kinetica.AggregateKMeansRequest.tolerance
getset

Stop iterating when the distances between successive points is less than the given tolerance.

Definition at line 153 of file AggregateKMeans.cs.

The documentation for this class was generated from the following files: