cudf::ast::detail::predicate Class Reference

An expression that represents a predicate. More...

#include <cudf/ast/expressions.hpp>

Inheritance diagram for cudf::ast::detail::predicate:

Public Member Functions
	predicate (expression const &source)
	Construct a new filter predicate object. 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, cuda::stream_ref stream) const override
	Returns true if the expression may evaluate to null. More...
std::unique_ptr< cudf::detail::row_ir::node >	accept (cudf::detail::row_ir::ast_converter &visitor) const override
	Accepts a visitor class. More...
expression const &	get_operand () const
	Get the operand expression. More...
Public Member Functions inherited from cudf::ast::expression
bool	may_evaluate_null (table_view const &left, cuda::stream_ref stream) const
	Returns true if the expression may evaluate to null. More...

Detailed Description

An expression that represents a predicate.

This is an internal expression used in filter operations. It is not intended to be used by external code and is not a part of the public API.

Definition at line 576 of file expressions.hpp.

Constructor & Destructor Documentation

predicate()

cudf::ast::detail::predicate::predicate ( expression const &  source )

inline

Construct a new filter predicate object.

Parameters

source

The source expression from which the predicate value is taken

Definition at line 582 of file expressions.hpp.

Member Function Documentation

accept() [1/3]

std::unique_ptr<cudf::detail::row_ir::node> cudf::ast::detail::predicate::accept ( cudf::detail::row_ir::ast_converter &  visitor ) const

overridevirtual

Accepts a visitor class.

Parameters

visitor

The expression_parser parsing this expression tree

Returns

Index of device data reference for this instance

Implements cudf::ast::expression.

accept() [2/3]

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

overridevirtual

Accepts a visitor class.

Parameters

visitor

The expression_parser parsing this expression tree

Returns

Index of device data reference for this instance

Implements cudf::ast::expression.

accept() [3/3]

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

overridevirtual

Accepts a visitor class.

Parameters

visitor

The expression_parser parsing this expression tree

Returns

Index of device data reference for this instance

Implements cudf::ast::expression.

get_operand()

expression const& cudf::ast::detail::predicate::get_operand ( ) const

inline

Get the operand expression.

Returns

The operand expression

Definition at line 609 of file expressions.hpp.

may_evaluate_null()

bool cudf::ast::detail::predicate::may_evaluate_null ( table_view const &  left, table_view const &  right, cuda::stream_ref  stream  ) const

overridevirtual

Returns true if the expression may evaluate to null.

Parameters

left	The left operand of the expression
right	The right operand of the expression
stream	CUDA stream used for device memory operations and kernel launches

Returns

true if the expression may evaluate to null, otherwise false

Implements cudf::ast::expression.

---

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

• cudf/ast/expressions.hpp