libcudf  24.04.00
Public Member Functions | List of all members
cudf::ast::column_name_reference Class Reference

A expression referring to data from a column in a table. More...

#include <expressions.hpp>

Inheritance diagram for cudf::ast::column_name_reference:
cudf::ast::expression

Public Member Functions

 column_name_reference (std::string column_name)
 Construct a new column name reference object. More...
 
std::string get_column_name () const
 Get the column name. More...
 
cudf::size_type accept (detail::expression_parser &visitor) const override
 Accepts a visitor class. More...
 
std::reference_wrapper< expression const > accept (detail::expression_transformer &visitor) const override
 Accepts a visitor class. More...
 
bool may_evaluate_null (table_view const &left, table_view const &right, rmm::cuda_stream_view stream) const override
 Returns true if the expression may evaluate to null. More...
 
- Public Member Functions inherited from cudf::ast::expression
bool may_evaluate_null (table_view const &left, rmm::cuda_stream_view stream) const
 Returns true if the expression may evaluate to null. More...
 

Detailed Description

A expression referring to data from a column in a table.

Definition at line 513 of file expressions.hpp.

Constructor & Destructor Documentation

◆ column_name_reference()

cudf::ast::column_name_reference::column_name_reference ( std::string  column_name)
inline

Construct a new column name reference object.

Parameters
column_nameName of this column in the table metadata (provided when the expression is evaluated).

Definition at line 521 of file expressions.hpp.

Member Function Documentation

◆ accept() [1/2]

cudf::size_type cudf::ast::column_name_reference::accept ( detail::expression_parser &  visitor) const
overridevirtual

Accepts a visitor class.

Parameters
visitorThe expression_parser parsing this expression tree
Returns
Index of device data reference for this instance

Implements cudf::ast::expression.

◆ accept() [2/2]

std::reference_wrapper<expression const> cudf::ast::column_name_reference::accept ( detail::expression_transformer &  visitor) const
overridevirtual

Accepts a visitor class.

Parameters
visitorThe expression_parser parsing this expression tree
Returns
Index of device data reference for this instance

Implements cudf::ast::expression.

◆ get_column_name()

std::string cudf::ast::column_name_reference::get_column_name ( ) const
inline

Get the column name.

Returns
The name of this column reference

Definition at line 528 of file expressions.hpp.

◆ may_evaluate_null()

bool cudf::ast::column_name_reference::may_evaluate_null ( table_view const &  left,
table_view const &  right,
rmm::cuda_stream_view  stream 
) const
inlineoverridevirtual

Returns true if the expression may evaluate to null.

Parameters
leftThe left operand of the expression
rightThe right operand of the expression
streamCUDA stream used for device memory operations and kernel launches
Returns
true if the expression may evaluate to null, otherwise false

Implements cudf::ast::expression.

Definition at line 541 of file expressions.hpp.


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