> ## 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. # aggregateStatisticsByRange

◆ aggregateStatisticsByRange() \[1/2]

AggregateStatisticsByRangeResponse kinetica.Kinetica.aggregateStatisticsByRange ( AggregateStatisticsByRangeRequest request\_ )
inline

Divides the given set into bins and calculates statistics of the values of a value-column in each bin.

The bins are based on the values of a given binning-column. The statistics that may be requested are mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, first, last and weighted average. In addition to the requested statistics the count of total samples in each bin is returned. This counts vector is just the histogram of the column used to divide the set members into bins. The weighted average statistic requires a weight column to be specified in WEIGHT\_COLUMN\_NAME. The weighted average is then defined as the sum of the products of the value column times the weight column divided by the sum of the weight column.

There are two methods for binning the set members. In the first, which can be used for numeric valued binning-columns, a min, max and interval are specified. The number of bins, nbins, is the integer upper bound of (max-min)/interval. Values that fall in the range \[min+n\*interval,min+(n+1)\*interval) are placed in the nth bin where n ranges from 0..nbin-2. The final bin is \[min+(nbin-1)\*interval,max]. In the second method, BIN\_VALUES specifies a list of binning column values. Binning-columns whose value matches the nth member of the BIN\_VALUES list are placed in the nth bin. When a list is provided, the binning-column must be of type string or int.

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

Parameters
request\_ Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 6457 of file KineticaFunctions.cs.

◆ aggregateStatisticsByRange() \[2/2]

AggregateStatisticsByRangeResponse kinetica.Kinetica.aggregateStatisticsByRange ( string table\_name,
string select\_expression,
string column\_name,
string value\_column\_name,
string stats,
double start,
double end,
double interval,
IDictionary\< string, string > options = null )
inline

Divides the given set into bins and calculates statistics of the values of a value-column in each bin.

The bins are based on the values of a given binning-column. The statistics that may be requested are mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, first, last and weighted average. In addition to the requested statistics the count of total samples in each bin is returned. This counts vector is just the histogram of the column used to divide the set members into bins. The weighted average statistic requires a weight column to be specified in WEIGHT\_COLUMN\_NAME. The weighted average is then defined as the sum of the products of the value column times the weight column divided by the sum of the weight column.

There are two methods for binning the set members. In the first, which can be used for numeric valued binning-columns, a min, max and interval are specified. The number of bins, nbins, is the integer upper bound of (max-min)/interval. Values that fall in the range \[min+n\*interval,min+(n+1)\*interval) are placed in the nth bin where n ranges from 0..nbin-2. The final bin is \[min+(nbin-1)\*interval,max]. In the second method, BIN\_VALUES specifies a list of binning column values. Binning-columns whose value matches the nth member of the BIN\_VALUES list are placed in the nth bin. When a list is provided, the binning-column must be of type string or int.

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

Parameters
table\_name Name of the table on which the ranged-statistics operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules.
select\_expression For a non-empty expression statistics are calculated for those records for which the expression is true. The default value is ''.
column\_name Name of the binning-column used to divide the set samples into bins.
value\_column\_name Name of the value-column for which statistics are to be computed.
stats A string of comma separated list of the statistics to calculate, e.g. 'sum,mean'. Available statistics: mean, stdv (standard deviation), variance, skew, kurtosis, sum.
start The lower bound of the binning-column.
end The upper bound of the binning-column.
interval The interval of a bin. Set members fall into bin i if the binning-column falls in the range \[start+interval\*i, start+interval\*(i+1)).
options Optional parameters.
  • ADDITIONAL\_COLUMN\_NAMES: A list of comma separated value-column names over which statistics can be accumulated along with the primary value\_column.
  • BIN\_VALUES: A list of comma separated binning-column values. Values that match the nth bin\_values value are placed in the nth bin.
  • WEIGHT\_COLUMN\_NAME: Name of the column used as weighting column for the weighted\_average statistic.
  • ORDER\_COLUMN\_NAME: Name of the column used for candlestick charting techniques.
The default value is an empty Dictionary.
Returns
Response object containing the result of the operation.

Definition at line 6594 of file KineticaFunctions.cs.

◆ AggregateStatisticsByRangeAsync() \[1/2]

async System.Threading.Tasks.Task\< AggregateStatisticsByRangeResponse > kinetica.Kinetica.AggregateStatisticsByRangeAsync ( AggregateStatisticsByRangeRequest request\_,
System.Threading.CancellationToken cancellationToken = default )
inline

Divides the given set into bins and calculates statistics of the values of a value-column in each bin.

(async)

The bins are based on the values of a given binning-column. The statistics that may be requested are mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, first, last and weighted average. In addition to the requested statistics the count of total samples in each bin is returned. This counts vector is just the histogram of the column used to divide the set members into bins. The weighted average statistic requires a weight column to be specified in WEIGHT\_COLUMN\_NAME. The weighted average is then defined as the sum of the products of the value column times the weight column divided by the sum of the weight column.

There are two methods for binning the set members. In the first, which can be used for numeric valued binning-columns, a min, max and interval are specified. The number of bins, nbins, is the integer upper bound of (max-min)/interval. Values that fall in the range \[min+n\*interval,min+(n+1)\*interval) are placed in the nth bin where n ranges from 0..nbin-2. The final bin is \[min+(nbin-1)\*interval,max]. In the second method, BIN\_VALUES specifies a list of binning column values. Binning-columns whose value matches the nth member of the BIN\_VALUES list are placed in the nth bin. When a list is provided, the binning-column must be of type string or int.

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

Parameters
request\_ Request object containing the parameters for the operation.
cancellationToken Cancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 6500 of file KineticaFunctions.cs.

◆ AggregateStatisticsByRangeAsync() \[2/2]

async System.Threading.Tasks.Task\< AggregateStatisticsByRangeResponse > kinetica.Kinetica.AggregateStatisticsByRangeAsync ( string table\_name,
string select\_expression,
string column\_name,
string value\_column\_name,
string stats,
double start,
double end,
double interval,
IDictionary\< string, string > options = null,
System.Threading.CancellationToken cancellationToken = default )
inline

Divides the given set into bins and calculates statistics of the values of a value-column in each bin.

(async)

The bins are based on the values of a given binning-column. The statistics that may be requested are mean, stdv (standard deviation), variance, skew, kurtosis, sum, min, max, first, last and weighted average. In addition to the requested statistics the count of total samples in each bin is returned. This counts vector is just the histogram of the column used to divide the set members into bins. The weighted average statistic requires a weight column to be specified in WEIGHT\_COLUMN\_NAME. The weighted average is then defined as the sum of the products of the value column times the weight column divided by the sum of the weight column.

There are two methods for binning the set members. In the first, which can be used for numeric valued binning-columns, a min, max and interval are specified. The number of bins, nbins, is the integer upper bound of (max-min)/interval. Values that fall in the range \[min+n\*interval,min+(n+1)\*interval) are placed in the nth bin where n ranges from 0..nbin-2. The final bin is \[min+(nbin-1)\*interval,max]. In the second method, BIN\_VALUES specifies a list of binning column values. Binning-columns whose value matches the nth member of the BIN\_VALUES list are placed in the nth bin. When a list is provided, the binning-column must be of type string or int.

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

Parameters
table\_name Name of the table on which the ranged-statistics operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules.
select\_expression For a non-empty expression statistics are calculated for those records for which the expression is true. The default value is ''.
column\_name Name of the binning-column used to divide the set samples into bins.
value\_column\_name Name of the value-column for which statistics are to be computed.
stats A string of comma separated list of the statistics to calculate, e.g. 'sum,mean'. Available statistics: mean, stdv (standard deviation), variance, skew, kurtosis, sum.
start The lower bound of the binning-column.
end The upper bound of the binning-column.
interval The interval of a bin. Set members fall into bin i if the binning-column falls in the range \[start+interval\*i, start+interval\*(i+1)).
options Optional parameters.
  • ADDITIONAL\_COLUMN\_NAMES: A list of comma separated value-column names over which statistics can be accumulated along with the primary value\_column.
  • BIN\_VALUES: A list of comma separated binning-column values. Values that match the nth bin\_values value are placed in the nth bin.
  • WEIGHT\_COLUMN\_NAME: Name of the column used as weighting column for the weighted\_average statistic.
  • ORDER\_COLUMN\_NAME: Name of the column used for candlestick charting techniques.
The default value is an empty Dictionary.
cancellationToken Cancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 6703 of file KineticaFunctions.cs.