Kinetica   C#   API  Version 7.2.3.0
kinetica.AggregateKMeansRequest.Options Struct Reference

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

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. More...
 
const string MAX_ITERS = "max_iters"
 Number of times to try to hit the tolerance limit before giving up - default is 10. More...
 
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. More...
 
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. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string RESULT_TABLE = "result_table"
 The name of a table used to store the results, in [schema_name. More...
 
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. More...
 
const string TTL = "ttl"
 Sets the TTL of the table specified in RESULT_TABLE. More...
 

Detailed Description

A set of string constants for the parameter 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"

If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of RESULT_TABLE.

Supported values:

The default value is FALSE.

Definition at line 61 of file AggregateKMeans.cs.

◆ FALSE

const string kinetica.AggregateKMeansRequest.Options.FALSE = "false"

Definition at line 64 of file AggregateKMeans.cs.

◆ MAX_ITERS

const string kinetica.AggregateKMeansRequest.Options.MAX_ITERS = "max_iters"

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"

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"

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 74 of file AggregateKMeans.cs.

◆ RESULT_TABLE_PERSIST

const string kinetica.AggregateKMeansRequest.Options.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.

Supported values:

The default value is FALSE.

Definition at line 92 of file AggregateKMeans.cs.

◆ TRUE

const string kinetica.AggregateKMeansRequest.Options.TRUE = "true"

Definition at line 63 of file AggregateKMeans.cs.

◆ TTL

const string kinetica.AggregateKMeansRequest.Options.TTL = "ttl"

Sets the TTL of the table specified in RESULT_TABLE.

Definition at line 97 of file AggregateKMeans.cs.

◆ WHITEN

const string kinetica.AggregateKMeansRequest.Options.WHITEN = "whiten"

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 file: