Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Public Attributes | List of all members
kinetica.AggregateKMeansRequest.Options Struct Reference

Optional parameters. 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

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

Definition at line 128 of file AggregateKMeans.cs.

Member Data Documentation

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.

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

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

Definition at line 166 of file AggregateKMeans.cs.

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

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

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

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.

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

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

Definition at line 165 of file AggregateKMeans.cs.

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

Sets the TTL of the table specified in result_table.

Definition at line 201 of file AggregateKMeans.cs.

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

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