Skip to main content

◆ aggregateHistogram() [1/2]

AggregateHistogramResponse kinetica.Kinetica.aggregateHistogram (AggregateHistogramRequestrequest_)
inline

Performs a histogram calculation given a table, a column, and an interval function.

The interval is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive–except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a VALUE_COLUMN. In this latter case the sum of the values corresponding to the VALUE_COLUMN is used as the result instead. The total number of bins requested cannot exceed 10,000.

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

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 5144 of file KineticaFunctions.cs.

◆ aggregateHistogram() [2/2]

AggregateHistogramResponse kinetica.Kinetica.aggregateHistogram (stringtable_name,
stringcolumn_name,
doublestart,
doubleend,
doubleinterval,
IDictionary< string, string >options = null )
inline

Performs a histogram calculation given a table, a column, and an interval function.

The interval is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive–except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a VALUE_COLUMN. In this latter case the sum of the values corresponding to the VALUE_COLUMN is used as the result instead. The total number of bins requested cannot exceed 10,000.

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

Parameters
table_nameName 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_nameName of a column or an expression of one or more column names over which the histogram will be calculated.
startLower end value of the histogram interval, inclusive.
endUpper end value of the histogram interval, inclusive.
intervalThe size of each bin within the start and end parameters.
optionsOptional parameters.
  • VALUE_COLUMN: The name of the column to use when calculating the bin values (values are summed). The column must be a numerical type (int, double, long, float).
  • START: The start parameter for char types.
  • END: The end parameter for char types.
  • INTERVAL: The interval parameter for char types.
The default value is an empty Dictionary.
Returns
Response object containing the result of the operation.

Definition at line 5249 of file KineticaFunctions.cs.

◆ AggregateHistogramAsync() [1/2]

async System.Threading.Tasks.Task< AggregateHistogramResponse > kinetica.Kinetica.AggregateHistogramAsync (AggregateHistogramRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
inline

Performs a histogram calculation given a table, a column, and an interval function.

(async)

The interval is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive–except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a VALUE_COLUMN. In this latter case the sum of the values corresponding to the VALUE_COLUMN is used as the result instead. The total number of bins requested cannot exceed 10,000.

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

Parameters
request_Request object containing the parameters for the operation.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 5177 of file KineticaFunctions.cs.

◆ AggregateHistogramAsync() [2/2]

async System.Threading.Tasks.Task< AggregateHistogramResponse > kinetica.Kinetica.AggregateHistogramAsync (stringtable_name,
stringcolumn_name,
doublestart,
doubleend,
doubleinterval,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
inline

Performs a histogram calculation given a table, a column, and an interval function.

(async)

The interval is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive–except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a VALUE_COLUMN. In this latter case the sum of the values corresponding to the VALUE_COLUMN is used as the result instead. The total number of bins requested cannot exceed 10,000.

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

Parameters
table_nameName 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_nameName of a column or an expression of one or more column names over which the histogram will be calculated.
startLower end value of the histogram interval, inclusive.
endUpper end value of the histogram interval, inclusive.
intervalThe size of each bin within the start and end parameters.
optionsOptional parameters.
  • VALUE_COLUMN: The name of the column to use when calculating the bin values (values are summed). The column must be a numerical type (int, double, long, float).
  • START: The start parameter for char types.
  • END: The end parameter for char types.
  • INTERVAL: The interval parameter for char types.
The default value is an empty Dictionary.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 5327 of file KineticaFunctions.cs.