A set of parameters for GPUdb::aggregateStatisticsByRange. More...

#include <gpudb/protocol/aggregate_statistics_by_range.h>

Public Member Functions
	AggregateStatisticsByRangeRequest ()
	Constructs an AggregateStatisticsByRangeRequest object with default parameters. More...

	AggregateStatisticsByRangeRequest (const std::string &tableName_, const std::string &selectExpression_, const std::string &columnName_, const std::string &valueColumnName_, const std::string &stats_, const double start_, const double end_, const double interval_, const std::map< std::string, std::string > &options_)
	Constructs an AggregateStatisticsByRangeRequest object with the specified parameters. More...

Public Attributes
std::string	tableName
	Name of the table on which the ranged-statistics operation will be performed, in [ schema_name. ]table_name format, using standard name resolution rules. More...

std::string	selectExpression
	For a non-empty expression statistics are calculated for those records for which the expression is true. More...

std::string	columnName
	Name of the binning-column used to divide the set samples into bins. More...

std::string	valueColumnName
	Name of the value-column for which statistics are to be computed. More...

std::string	stats
	A string of comma separated list of the statistics to calculate, e.g. 'sum,mean'. More...

double	start
	The lower bound of the binning-column. More...

double	end
	The upper bound of the binning-column. More...

double	interval
	The interval of a bin. More...

std::map< std::string, std::string >	options
	Map of optional parameters: More...

Detailed Description

A set of parameters for GPUdb::aggregateStatisticsByRange.

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.

Definition at line 46 of file aggregate_statistics_by_range.h.

Constructor & Destructor Documentation

◆ AggregateStatisticsByRangeRequest() [1/2]

gpudb::AggregateStatisticsByRangeRequest::AggregateStatisticsByRangeRequest ( )

inline

Constructs an AggregateStatisticsByRangeRequest object with default parameters.

Definition at line 52 of file aggregate_statistics_by_range.h.

◆ AggregateStatisticsByRangeRequest() [2/2]

gpudb::AggregateStatisticsByRangeRequest::AggregateStatisticsByRangeRequest	(	const std::string &	tableName_,
		const std::string &	selectExpression_,
		const std::string &	columnName_,
		const std::string &	valueColumnName_,
		const std::string &	stats_,
		const double	start_,
		const double	end_,
		const double	interval_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs an AggregateStatisticsByRangeRequest object with the specified parameters.

Parameters

[in]	tableName_	Name of the table on which the ranged-statistics operation will be performed, in [schema_name.]table_name format, using standard name resolution rules.
[in]	selectExpression_	For a non-empty expression statistics are calculated for those records for which the expression is true. The default value is ''.
[in]	columnName_	Name of the binning-column used to divide the set samples into bins.
[in]	valueColumnName_	Name of the value-column for which statistics are to be computed.
[in]	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.
[in]	start_	The lower bound of the binning-column.
[in]	end_	The upper bound of the binning-column.
[in]	interval_	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)).
[in]	options_	Map of optional parameters: aggregate_statistics_by_range_additional_column_names: A list of comma separated value-column names over which statistics can be accumulated along with the primary value_column. aggregate_statistics_by_range_bin_values: A list of comma separated binning-column values. Values that match the nth bin_values value are placed in the nth bin. aggregate_statistics_by_range_weight_column_name: Name of the column used as weighting column for the weighted_average statistic. aggregate_statistics_by_range_order_column_name: Name of the column used for candlestick charting techniques. The default value is an empty map.

Definition at line 122 of file aggregate_statistics_by_range.h.

Member Data Documentation

◆ columnName

std::string gpudb::AggregateStatisticsByRangeRequest::columnName

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

Definition at line 152 of file aggregate_statistics_by_range.h.

◆ end

double gpudb::AggregateStatisticsByRangeRequest::end

The upper bound of the binning-column.

Definition at line 174 of file aggregate_statistics_by_range.h.

◆ interval

double gpudb::AggregateStatisticsByRangeRequest::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)).

Definition at line 181 of file aggregate_statistics_by_range.h.

◆ options

std::map<std::string, std::string> gpudb::AggregateStatisticsByRangeRequest::options

Map of optional parameters:

aggregate_statistics_by_range_additional_column_names: A list of comma separated value-column names over which statistics can be accumulated along with the primary value_column.
aggregate_statistics_by_range_bin_values: A list of comma separated binning-column values. Values that match the nth bin_values value are placed in the nth bin.
aggregate_statistics_by_range_weight_column_name: Name of the column used as weighting column for the weighted_average statistic.
aggregate_statistics_by_range_order_column_name: Name of the column used for candlestick charting techniques.

The default value is an empty map.

Definition at line 206 of file aggregate_statistics_by_range.h.

◆ selectExpression

std::string gpudb::AggregateStatisticsByRangeRequest::selectExpression

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

The default value is ''.

Definition at line 147 of file aggregate_statistics_by_range.h.

◆ start

double gpudb::AggregateStatisticsByRangeRequest::start

The lower bound of the binning-column.

Definition at line 169 of file aggregate_statistics_by_range.h.

◆ stats

std::string gpudb::AggregateStatisticsByRangeRequest::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.

Definition at line 164 of file aggregate_statistics_by_range.h.

◆ tableName

std::string gpudb::AggregateStatisticsByRangeRequest::tableName

Name of the table on which the ranged-statistics operation will be performed, in [ schema_name. ]table_name format, using standard name resolution rules.

Definition at line 141 of file aggregate_statistics_by_range.h.

◆ valueColumnName

std::string gpudb::AggregateStatisticsByRangeRequest::valueColumnName

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

Definition at line 157 of file aggregate_statistics_by_range.h.

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

gpudb/protocol/aggregate_statistics_by_range.h

Public Member Functions

Public Attributes