GPUdb C++ API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
gpudb::AggregateStatisticsByRangeResponse Struct Reference

A set of output parameters for const. More...

#include <gpudb/protocol/aggregate_statistics_by_range.h>

Public Member Functions

 AggregateStatisticsByRangeResponse ()
 Constructs an AggregateStatisticsByRangeResponse object with default parameter values. More...
 

Public Attributes

std::map< std::string,
std::vector< double > > 
stats
 
std::map< std::string,
std::string > 
info
 

Detailed Description

A set of output parameters for const.

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 options. 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, options 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.

Definition at line 250 of file aggregate_statistics_by_range.h.

Constructor & Destructor Documentation

gpudb::AggregateStatisticsByRangeResponse::AggregateStatisticsByRangeResponse ( )
inline

Constructs an AggregateStatisticsByRangeResponse object with default parameter values.

Definition at line 257 of file aggregate_statistics_by_range.h.

Member Data Documentation

std::map<std::string, std::string> gpudb::AggregateStatisticsByRangeResponse::info

Definition at line 264 of file aggregate_statistics_by_range.h.

std::map<std::string, std::vector<double> > gpudb::AggregateStatisticsByRangeResponse::stats

Definition at line 263 of file aggregate_statistics_by_range.h.


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