A set of parameters for Kinetica.aggregateStatisticsByRange. More...

Inheritance diagram for kinetica.AggregateStatisticsByRangeRequest:

Collaboration diagram for kinetica.AggregateStatisticsByRangeRequest:

Classes
struct	Options
	A set of string constants for the parameter options. More...

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

	AggregateStatisticsByRangeRequest (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)
	Constructs an AggregateStatisticsByRangeRequest object with the specified parameters. More...

Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...

object	Get (int fieldPos)
	Retrieve a specific property from this object More...

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	table_name `[get, set]`
	Name of the table on which the ranged-statistics operation will be performed, in [schema_name. More...

string	select_expression = "" `[get, set]`
	For a non-empty expression statistics are calculated for those records for which the expression is true. More...

string	column_name `[get, set]`
	Name of the binning-column used to divide the set samples into bins. More...

string	value_column_name `[get, set]`
	Name of the value-column for which statistics are to be computed. More...

string	stats `[get, set]`
	A string of comma separated list of the statistics to calculate, e.g. More...

double	start `[get, set]`
	The lower bound of the binning-column. More...

double	end `[get, set]`
	The upper bound of the binning-column. More...

double	interval `[get, set]`
	The interval of a bin. More...

IDictionary< string, string >	options = new Dictionary<string, string>() `[get, set]`
	Map of optional parameters: More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Additional Inherited Members
Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema	SchemaFromType (System.Type t, KineticaType? ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

Detailed Description

A set of parameters for Kinetica.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 41 of file AggregateStatisticsByRange.cs.

Constructor & Destructor Documentation

◆ AggregateStatisticsByRangeRequest() [1/2]

kinetica.AggregateStatisticsByRangeRequest.AggregateStatisticsByRangeRequest ( )

inline

Constructs an AggregateStatisticsByRangeRequest object with default parameters.

Definition at line 142 of file AggregateStatisticsByRange.cs.

◆ AggregateStatisticsByRangeRequest() [2/2]

kinetica.AggregateStatisticsByRangeRequest.AggregateStatisticsByRangeRequest	(	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

Constructs an AggregateStatisticsByRangeRequest object with the specified parameters.

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+intervali, start+interval(i+1)).
options	Map of 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.

Definition at line 201 of file AggregateStatisticsByRange.cs.

Property Documentation

◆ column_name

string kinetica.AggregateStatisticsByRangeRequest.column_name

getset

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

Definition at line 81 of file AggregateStatisticsByRange.cs.

◆ end

double kinetica.AggregateStatisticsByRangeRequest.end

getset

The upper bound of the binning-column.

Definition at line 97 of file AggregateStatisticsByRange.cs.

◆ interval

double kinetica.AggregateStatisticsByRangeRequest.interval

getset

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 103 of file AggregateStatisticsByRange.cs.

◆ options

IDictionary<string, string> kinetica.AggregateStatisticsByRangeRequest.options = new Dictionary<string, string>()

getset

Map of 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.

Definition at line 138 of file AggregateStatisticsByRange.cs.

◆ select_expression

string kinetica.AggregateStatisticsByRangeRequest.select_expression = ""

getset

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

The default value is ''.

Definition at line 77 of file AggregateStatisticsByRange.cs.

◆ start

double kinetica.AggregateStatisticsByRangeRequest.start

getset

The lower bound of the binning-column.

Definition at line 94 of file AggregateStatisticsByRange.cs.

◆ stats

string kinetica.AggregateStatisticsByRangeRequest.stats

getset

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 91 of file AggregateStatisticsByRange.cs.

◆ table_name

string kinetica.AggregateStatisticsByRangeRequest.table_name

getset

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 72 of file AggregateStatisticsByRange.cs.

◆ value_column_name

string kinetica.AggregateStatisticsByRangeRequest.value_column_name

getset

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

Definition at line 85 of file AggregateStatisticsByRange.cs.

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

Kinetica/Protocol/AggregateStatisticsByRange.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AggregateStatisticsByRangeRequest() [1/2]

◆ AggregateStatisticsByRangeRequest() [2/2]

Property Documentation

◆ column_name

◆ end

◆ interval

◆ options

◆ select_expression

◆ start

◆ stats

◆ table_name

◆ value_column_name