cudf::aggregation Class Reference

Abstract base class for specifying the desired aggregation in an aggregation_request. More...

#include <aggregation.hpp>

Inheritance diagram for cudf::aggregation:

Public Types
enum	Kind : int32_t {   SUM = 0 , SUM_OVERFLOW , SUM_WITH_OVERFLOW = SUM_OVERFLOW , PRODUCT ,   MIN , MAX , COUNT_VALID , COUNT_ALL ,   ANY , ALL , SUM_OF_SQUARES , MEAN ,   M2 , VARIANCE , STD , MEDIAN ,   QUANTILE , ARGMAX , ARGMIN , NUNIQUE ,   NTH_ELEMENT , ROW_NUMBER , EWMA , RANK ,   COLLECT_LIST , COLLECT_SET , LEAD , LAG ,   PTX , CUDA , HOST_UDF , MERGE_LISTS ,   MERGE_SETS , MERGE_M2 , COVARIANCE , CORRELATION ,   TDIGEST , MERGE_TDIGEST , HISTOGRAM , MERGE_HISTOGRAM ,   BITWISE_AGG , TOP_K , INVALID }
	Possible aggregation operations. More...

Public Member Functions
	aggregation ()
	Default constructor. More...
	aggregation (Kind kind_)
	Construct a new aggregation object from a given aggregation kind. More...
bool	is_valid () const
	Checks if the aggregation is valid, i.e. it was constructed with a valid value for the aggregation kind. More...
virtual bool	is_equal (aggregation const &other) const
	Compares two aggregation objects for equality. More...
virtual size_t	do_hash () const
	Computes the hash value of the aggregation. More...
virtual std::unique_ptr< aggregation >	clone () const =0
	Clones the aggregation object. More...

Public Attributes
Kind	kind
	The aggregation to perform.

Detailed Description

Abstract base class for specifying the desired aggregation in an aggregation_request.

All aggregations must derive from this class to implement the pure virtual functions and potentially encapsulate additional information needed to compute the aggregation.

Definition at line 74 of file aggregation.hpp.

Member Enumeration Documentation

Kind

enum cudf::aggregation::Kind : int32_t

Possible aggregation operations.

Enumerator
SUM	sum reduction
SUM_OVERFLOW	sum reduction with overflow detection
SUM_WITH_OVERFLOW	Deprecated: Use SUM_OVERFLOW instead.
PRODUCT	product reduction
MIN	min reduction
MAX	max reduction
COUNT_VALID	count number of valid elements
COUNT_ALL	count number of elements
ANY	any reduction
ALL	all reduction
SUM_OF_SQUARES	sum of squares reduction
MEAN	arithmetic mean reduction
M2	sum of squares of differences from the mean
VARIANCE	variance
STD	standard deviation
MEDIAN	median reduction
QUANTILE	compute specified quantile(s)
ARGMAX	Index of max element.
ARGMIN	Index of min element.
NUNIQUE	count number of unique elements
NTH_ELEMENT	get the nth element
ROW_NUMBER	get row-number of current index (relative to rolling window)
EWMA	get exponential weighted moving average at current index
RANK	get rank of current index
COLLECT_LIST	collect values into a list
COLLECT_SET	collect values into a list without duplicate entries
LEAD	window function, accesses row at specified offset following current row
LAG	window function, accesses row at specified offset preceding current row
PTX	PTX based UDF aggregation.
CUDA	CUDA based UDF aggregation.
HOST_UDF	host based UDF aggregation
MERGE_LISTS	merge multiple lists values into one list
MERGE_SETS	merge multiple lists values into one list then drop duplicate entries
MERGE_M2	merge partial values of M2 aggregation,
COVARIANCE	covariance between two sets of elements
CORRELATION	correlation between two sets of elements
TDIGEST	create a tdigest from a set of input values
MERGE_TDIGEST	create a tdigest by merging multiple tdigests together
HISTOGRAM	compute frequency of each element
MERGE_HISTOGRAM	merge partial values of HISTOGRAM aggregation
BITWISE_AGG	bitwise aggregation on numeric columns
TOP_K	top k elements in a group
INVALID	invalid aggregation, used as a placeholder when default-constructed

Definition at line 79 of file aggregation.hpp.

Constructor & Destructor Documentation

aggregation() [1/2]

cudf::aggregation::aggregation ( )

inline

Default constructor.

This constructor should not be called at all. It only exists to satisfy the compiler requirements.

Definition at line 132 of file aggregation.hpp.

aggregation() [2/2]

cudf::aggregation::aggregation ( Kind  kind_ )

inline

Construct a new aggregation object from a given aggregation kind.

Parameters

kind_

aggregation::Kind enum value

Definition at line 142 of file aggregation.hpp.

Member Function Documentation

clone()

virtual std::unique_ptr<aggregation> cudf::aggregation::clone ( ) const

pure virtual

Clones the aggregation object.

Returns

A copy of the aggregation object

do_hash()

virtual size_t cudf::aggregation::do_hash ( ) const

inlinevirtual

Computes the hash value of the aggregation.

Returns

The hash value of the aggregation

Definition at line 167 of file aggregation.hpp.

is_equal()

virtual bool cudf::aggregation::is_equal ( aggregation const &  other ) const

inlinevirtual

Compares two aggregation objects for equality.

Parameters

other

The other aggregation to compare with

Returns

True if the two aggregations are equal

Definition at line 160 of file aggregation.hpp.

is_valid()

bool cudf::aggregation::is_valid ( ) const

inline

Checks if the aggregation is valid, i.e. it was constructed with a valid value for the aggregation kind.

Returns

True if the aggregation is valid, false otherwise

Definition at line 152 of file aggregation.hpp.

---

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

• aggregation.hpp