Skip to main content

  • 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: string

      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: string | undefined

      For a non-empty expression statistics are calculated for those records for which the expression is true.

    • column_name: string

      Name of the binning-column used to divide the set samples into bins.

    • value_column_name: string

      Name of the value-column for which statistics are to be computed.

    • stats: string

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

      The lower bound of the binning-column.

    • end: number

      The upper bound of the binning-column.

    • interval: number

      The interval of a bin. Set members fall into bin i if the binning-column falls in the range [start+intervali, start+interval(i+1)).

    • Optionaloptions: Record<string, string>

      Optional parameters.

    • Optionalcallback: GPUdbCallback

      Optional callback function

    ​
    Returns Promise<AggregateStatisticsByRangeResponse>

    Promise<Types.AggregateStatisticsByRangeResponse> - Promise resolving to the response

  • 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

    ​
    Returns Promise<AggregateStatisticsByRangeResponse>

    Promise<Types.AggregateStatisticsByRangeResponse> - Promise resolving to the response