Skip to main content

A set of string constants for the parameter AggregateKMeansRequest.options. More…

Static Public Attributes

const string WHITEN = “whiten”
 When set to 1 each of the columns is first normalized by its stdv - default is not to whiten.
 
const string MAX_ITERS = “max_iters”
 Number of times to try to hit the tolerance limit before giving up - default is 10.
 
const string NUM_TRIES = “num_tries”
 Number of times to run the k-means algorithm with a different randomly selected starting points - helps avoid local minimum.
 
const string CREATE_TEMP_TABLE = “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.
 
const string TRUE = “true”
 A boolean constant for the AggregateKMeansRequest.Options options.
 
const string FALSE = “false”
 A boolean constant for the AggregateKMeansRequest.Options options.
 
const string RESULT_TABLE = “result_table”
 The name of a table used to store the results, in [schema_name.
 
const string RESULT_TABLE_PERSIST = “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.
 
const string TTL = “ttl”
 Sets the TTL of the table specified in RESULT_TABLE.
 

Detailed Description

A set of string constants for the parameter AggregateKMeansRequest.options.

Optional parameters.

Definition at line 30 of file AggregateKMeans.cs.

Member Data Documentation

◆ CREATE_TEMP_TABLE

const string kinetica.AggregateKMeansRequest.Options.CREATE_TEMP_TABLE = “create_temp_table”
static

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.

Definition at line 75 of file AggregateKMeans.cs.

◆ FALSE

const string kinetica.AggregateKMeansRequest.Options.FALSE = “false”
static

A boolean constant for the AggregateKMeansRequest.Options options.

Definition at line 83 of file AggregateKMeans.cs.

◆ MAX_ITERS

const string kinetica.AggregateKMeansRequest.Options.MAX_ITERS = “max_iters”
static

Number of times to try to hit the tolerance limit before giving up - default is 10.

Definition at line 38 of file AggregateKMeans.cs.

◆ NUM_TRIES

const string kinetica.AggregateKMeansRequest.Options.NUM_TRIES = “num_tries”
static

Number of times to run the k-means algorithm with a different randomly selected starting points - helps avoid local minimum.

Default is 1.

Definition at line 44 of file AggregateKMeans.cs.

◆ RESULT_TABLE

const string kinetica.AggregateKMeansRequest.Options.RESULT_TABLE = “result_table”
static

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.

Definition at line 93 of file AggregateKMeans.cs.

◆ RESULT_TABLE_PERSIST

const string kinetica.AggregateKMeansRequest.Options.RESULT_TABLE_PERSIST = “result_table_persist”
static

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.

Definition at line 123 of file AggregateKMeans.cs.

◆ TRUE

const string kinetica.AggregateKMeansRequest.Options.TRUE = “true”
static

A boolean constant for the AggregateKMeansRequest.Options options.

Definition at line 79 of file AggregateKMeans.cs.

◆ TTL

const string kinetica.AggregateKMeansRequest.Options.TTL = “ttl”
static

Sets the TTL of the table specified in RESULT_TABLE.

Definition at line 129 of file AggregateKMeans.cs.

◆ WHITEN

const string kinetica.AggregateKMeansRequest.Options.WHITEN = “whiten”
static

When set to 1 each of the columns is first normalized by its stdv - default is not to whiten.

Definition at line 34 of file AggregateKMeans.cs.


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