kinetica.AggregateHistogramRequest Class Reference

A set of parameters for Kinetica.aggregateHistogram(string,string,double,double,double,IDictionary{string, string}). More...

Inheritance diagram for kinetica.AggregateHistogramRequest:

Collaboration diagram for kinetica.AggregateHistogramRequest:

Classes
struct	Options
	Optional parameters. More...

Public Member Functions
	AggregateHistogramRequest ()
	Constructs an AggregateHistogramRequest object with default parameters. More...
	AggregateHistogramRequest (string table_name, string column_name, double start, double end, double interval, IDictionary< string, string > options=null)
	Constructs an AggregateHistogramRequest 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 operation will be performed. More...
string	column_name [get, set]
	Name of a column or an expression of one or more column names over which the histogram will be calculated. More...
double	start [get, set]
	Lower end value of the histogram interval, inclusive. More...
double	end [get, set]
	Upper end value of the histogram interval, inclusive. More...
double	interval [get, set]
	The size of each bin within the start and end parameters. More...
IDictionary< string, string >	options [get, set]
	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.aggregateHistogram(string,string,double,double,double,IDictionary{string, string}).

Performs a histogram calculation given a table, a column, and an interval function. The interval is used to produce bins of that size and the result, computed over the records falling within each bin, is returned. For each bin, the start value is inclusive, but the end value is exclusive–except for the very last bin for which the end value is also inclusive. The value returned for each bin is the number of records in it, except when a column name is provided as a value_column. In this latter case the sum of the values corresponding to the value_column is used as the result instead. The total number of bins requested cannot exceed 10,000.
NOTE: The Kinetica instance being accessed must be running a CUDA (GPU-based) build to service a request that specifies a value_column option.

Definition at line 32 of file AggregateHistogram.cs.

Constructor & Destructor Documentation

kinetica.AggregateHistogramRequest.AggregateHistogramRequest ( )

inline

Constructs an AggregateHistogramRequest object with default parameters.

Definition at line 94 of file AggregateHistogram.cs.

kinetica.AggregateHistogramRequest.AggregateHistogramRequest ( string  table_name, string  column_name, double  start, double  end, double  interval, IDictionary< string, string >  options = null  )

inline

Constructs an AggregateHistogramRequest object with the specified parameters.

Parameters

table_name	Name of the table on which the operation will be performed. Must be an existing table or collection.
column_name	Name of a column or an expression of one or more column names over which the histogram will be calculated.
start	Lower end value of the histogram interval, inclusive.
end	Upper end value of the histogram interval, inclusive.
interval	The size of each bin within the start and end parameters.
options	Optional parameters. VALUE_COLUMN: The name of the column to use when calculating the bin values (values are summed). The column must be a numerical type (int, double, long, float). The default value is an empty Dictionary.

Definition at line 123 of file AggregateHistogram.cs.

Property Documentation

string kinetica.AggregateHistogramRequest.column_name

getset

Name of a column or an expression of one or more column names over which the histogram will be calculated.

Definition at line 64 of file AggregateHistogram.cs.

double kinetica.AggregateHistogramRequest.end

getset

Upper end value of the histogram interval, inclusive.

Definition at line 72 of file AggregateHistogram.cs.

double kinetica.AggregateHistogramRequest.interval

getset

The size of each bin within the start and end parameters.

Definition at line 76 of file AggregateHistogram.cs.

IDictionary<string, string> kinetica.AggregateHistogramRequest.options

getset

Optional parameters.

• VALUE_COLUMN: The name of the column to use when calculating the bin values (values are summed). The column must be a numerical type (int, double, long, float).

The default value is an empty Dictionary.

Definition at line 89 of file AggregateHistogram.cs.

double kinetica.AggregateHistogramRequest.start

getset

Lower end value of the histogram interval, inclusive.

Definition at line 68 of file AggregateHistogram.cs.

string kinetica.AggregateHistogramRequest.table_name

getset

Name of the table on which the operation will be performed.

Must be an existing table or collection.

Definition at line 60 of file AggregateHistogram.cs.

---

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

• Kinetica/Protocol/AggregateHistogram.cs