Files | Classes | Enumerations | Functions
Aggregation Factories

Files

file  aggregation.hpp
 Representation for specifying desired aggregations from aggregation-based APIs, e.g., groupby, reductions, rolling, etc.
 

Classes

class  cudf::aggregation
 Base class for specifying the desired aggregation in an aggregation_request. More...
 

Enumerations

enum  udf_type : bool { CUDA, PTX }
 

Functions

std::unique_ptr< aggregationcudf::make_sum_aggregation ()
 Factory to create a SUM aggregation.
 
std::unique_ptr< aggregationcudf::make_product_aggregation ()
 Factory to create a PRODUCT aggregation.
 
std::unique_ptr< aggregationcudf::make_min_aggregation ()
 Factory to create a MIN aggregation.
 
std::unique_ptr< aggregationcudf::make_max_aggregation ()
 Factory to create a MAX aggregation.
 
std::unique_ptr< aggregationcudf::make_count_aggregation (null_policy null_handling=null_policy::EXCLUDE)
 Factory to create a COUNT aggregation. More...
 
std::unique_ptr< aggregationcudf::make_any_aggregation ()
 Factory to create a ANY aggregation.
 
std::unique_ptr< aggregationcudf::make_all_aggregation ()
 Factory to create a ALL aggregation.
 
std::unique_ptr< aggregationcudf::make_sum_of_squares_aggregation ()
 Factory to create a SUM_OF_SQUARES aggregation.
 
std::unique_ptr< aggregationcudf::make_mean_aggregation ()
 Factory to create a MEAN aggregation.
 
std::unique_ptr< aggregationcudf::make_variance_aggregation (size_type ddof=1)
 Factory to create a VARIANCE aggregation. More...
 
std::unique_ptr< aggregationcudf::make_std_aggregation (size_type ddof=1)
 Factory to create a STD aggregation. More...
 
std::unique_ptr< aggregationcudf::make_median_aggregation ()
 Factory to create a MEDIAN aggregation.
 
std::unique_ptr< aggregationcudf::make_quantile_aggregation (std::vector< double > const &q, interpolation i=interpolation::LINEAR)
 Factory to create a QUANTILE aggregation. More...
 
std::unique_ptr< aggregationcudf::make_argmax_aggregation ()
 Factory to create an argmax aggregation. More...
 
std::unique_ptr< aggregationcudf::make_argmin_aggregation ()
 Factory to create an argmin aggregation. More...
 
std::unique_ptr< aggregationcudf::make_nunique_aggregation (null_policy null_handling=null_policy::EXCLUDE)
 Factory to create a nunique aggregation. More...
 
std::unique_ptr< aggregationcudf::make_nth_element_aggregation (size_type n, null_policy null_handling=null_policy::INCLUDE)
 Factory to create a nth_element aggregation. More...
 
std::unique_ptr< aggregationcudf::make_row_number_aggregation ()
 Factory to create a ROW_NUMBER aggregation.
 
std::unique_ptr< aggregationcudf::make_collect_aggregation ()
 Factory to create a COLLECT_NUMBER aggregation.
 
std::unique_ptr< aggregationcudf::make_lag_aggregation (size_type offset)
 Factory to create a LAG aggregation.
 
std::unique_ptr< aggregationcudf::make_lead_aggregation (size_type offset)
 Factory to create a LEAD aggregation.
 
std::unique_ptr< aggregationcudf::make_udf_aggregation (udf_type type, std::string const &user_defined_aggregator, data_type output_type)
 Factory to create an aggregation base on UDF for PTX or CUDA. More...
 

Detailed Description

Function Documentation

◆ make_argmax_aggregation()

std::unique_ptr<aggregation> cudf::make_argmax_aggregation ( )

Factory to create an argmax aggregation.

argmax returns the index of the maximum element.

◆ make_argmin_aggregation()

std::unique_ptr<aggregation> cudf::make_argmin_aggregation ( )

Factory to create an argmin aggregation.

argmin returns the index of the minimum element.

◆ make_count_aggregation()

std::unique_ptr<aggregation> cudf::make_count_aggregation ( null_policy  null_handling = null_policy::EXCLUDE)

Factory to create a COUNT aggregation.

Parameters
null_handlingIndicates if null values will be counted.

◆ make_nth_element_aggregation()

std::unique_ptr<aggregation> cudf::make_nth_element_aggregation ( size_type  n,
null_policy  null_handling = null_policy::INCLUDE 
)

Factory to create a nth_element aggregation.

nth_element returns the n'th element of the group/series.

If n is not within the range [-group_size, group_size), the result of the respective group will be null. Negative indices [-group_size, -1] corresponds to [0, group_size-1] indices respectively where group_size is the size of each group.

Parameters
nindex of nth element in each group.
null_handlingIndicates to include/exclude nulls during indexing.

◆ make_nunique_aggregation()

std::unique_ptr<aggregation> cudf::make_nunique_aggregation ( null_policy  null_handling = null_policy::EXCLUDE)

Factory to create a nunique aggregation.

nunique returns the number of unique elements.

Parameters
null_handlingIndicates if null values will be counted.

◆ make_quantile_aggregation()

std::unique_ptr<aggregation> cudf::make_quantile_aggregation ( std::vector< double > const &  q,
interpolation  i = interpolation::LINEAR 
)

Factory to create a QUANTILE aggregation.

Parameters
quantilesThe desired quantiles
interpolationThe desired interpolation

◆ make_std_aggregation()

std::unique_ptr<aggregation> cudf::make_std_aggregation ( size_type  ddof = 1)

Factory to create a STD aggregation.

Parameters
ddofDelta degrees of freedom. The divisor used in calculation of std is N - ddof, where N is the population size.

◆ make_udf_aggregation()

std::unique_ptr<aggregation> cudf::make_udf_aggregation ( udf_type  type,
std::string const &  user_defined_aggregator,
data_type  output_type 
)

Factory to create an aggregation base on UDF for PTX or CUDA.

Parameters
[in]typeeither udf_type::PTX or udf_type::CUDA
[in]user_defined_aggregatorA string containing the aggregator code
[in]output_typeexpected output type
Returns
aggregation unique pointer housing user_defined_aggregator string.

◆ make_variance_aggregation()

std::unique_ptr<aggregation> cudf::make_variance_aggregation ( size_type  ddof = 1)

Factory to create a VARIANCE aggregation.

Parameters
ddofDelta degrees of freedom. The divisor used in calculation of variance is N - ddof, where N is the population size.