souffle::ast::Aggregator Class Reference

Defines the aggregator class. More...

#include <Aggregator.h>

Inheritance diagram for souffle::ast::Aggregator:

Collaboration diagram for souffle::ast::Aggregator:

Public Member Functions
	Aggregator (AggregateOp baseOperator, Own< Argument > expr=nullptr, VecOwn< Literal > body={}, SrcLocation loc={})
void	apply (const NodeMapper &map) override
	Apply the mapper to all child nodes. More...
Aggregator *	clone () const override
	Create clone. More...
AggregateOp	getBaseOperator () const
	Return the (base type) operator of the aggregator. More...
std::vector< Literal * >	getBodyLiterals () const
	Return body literals. More...
std::vector< const Node * >	getChildNodes () const override
	Obtain a list of all embedded AST child nodes. More...
std::optional< AggregateOp >	getFinalType () const
const Argument *	getTargetExpression () const
	Return target expression. More...
void	setBody (VecOwn< Literal > bodyLiterals)
	Set body. More...
void	setFinalType (AggregateOp newType)
Public Member Functions inherited from souffle::ast::Argument
	Node (SrcLocation loc={})
Public Member Functions inherited from souffle::ast::Node
std::string	extloc () const
	Return source location of the syntactic element. More...
const SrcLocation &	getSrcLoc () const
	Return source location of the Node. More...
	Node (SrcLocation loc={})
bool	operator!= (const Node &other) const
	Inequality check for two AST nodes. More...
bool	operator== (const Node &other) const
	Equivalence check for two AST nodes. More...
void	setSrcLoc (SrcLocation l)
	Set source location for the Node. More...
virtual	~Node ()=default

Protected Member Functions
bool	equal (const Node &node) const override
	Abstract equality check for two AST nodes. More...
void	print (std::ostream &os) const override
	Output to a given output stream. More...

Private Attributes
AggregateOp	baseOperator
	Aggregate (base type) operator. More...
VecOwn< Literal >	body
	Body literal of sub-query. More...
std::optional< AggregateOp >	finalTranslatorType
Own< Argument >	targetExpression
	Aggregate expression. More...

Detailed Description

Defines the aggregator class.

Example: sum y+x: {A(y),B(x)}

Aggregates over a sub-query using an aggregate operator and an expression.

Definition at line 53 of file Aggregator.h.

Constructor & Destructor Documentation

Aggregator()

souffle::ast::Aggregator::Aggregator ( AggregateOp  baseOperator, Own< Argument >  expr = nullptr, VecOwn< Literal >  body = {}, SrcLocation  loc = {}  )

inline

Definition at line 55 of file Aggregator.h.

                                        {
        return baseOperator;
    }
 

References baseOperator.

Member Function Documentation

apply()

void souffle::ast::Aggregator::apply ( const NodeMapper &  )

inlineoverridevirtual

Apply the mapper to all child nodes.

Reimplemented from souffle::ast::Node.

Definition at line 100 of file Aggregator.h.

                                           {
        finalTranslatorType = newType;
    }
 
    std::optional<AggregateOp> getFinalType() const {

clone()

Aggregator* souffle::ast::Aggregator::clone ( ) const

inlineoverridevirtual

Create clone.

Implements souffle::ast::Argument.

Definition at line 91 of file Aggregator.h.

                                               {
        if (targetExpression) {
            targetExpression = map(std::move(targetExpression));
        }
        for (auto& cur : body) {

equal()

bool souffle::ast::Aggregator::equal ( const Node &  ) const

inlineoverrideprotectedvirtual

Abstract equality check for two AST nodes.

Reimplemented from souffle::ast::Node.

Definition at line 126 of file Aggregator.h.

       :
    /** Aggregate (base type) operator */
    AggregateOp baseOperator;
 
    /** Aggregate expression */

getBaseOperator()

AggregateOp souffle::ast::Aggregator::getBaseOperator ( ) const

inline

Return the (base type) operator of the aggregator.

Definition at line 61 of file Aggregator.h.

getBodyLiterals()

std::vector<Literal*> souffle::ast::Aggregator::getBodyLiterals ( ) const

inline

Return body literals.

Definition at line 71 of file Aggregator.h.

Referenced by souffle::ast::transform::RemoveEmptyRelationsTransformer::removeEmptyRelations().

getChildNodes()

std::vector<const Node*> souffle::ast::Aggregator::getChildNodes ( ) const

inlineoverridevirtual

Obtain a list of all embedded AST child nodes.

Reimplemented from souffle::ast::Node.

Definition at line 80 of file Aggregator.h.

                                       {
        auto* copy = new Aggregator(
                baseOperator, souffle::clone(targetExpression), souffle::clone(body), getSrcLoc());
        if (finalTranslatorType.has_value()) {
            copy->setFinalType(finalTranslatorType.value());

getFinalType()

std::optional<AggregateOp> souffle::ast::Aggregator::getFinalType ( ) const

inline

Definition at line 113 of file Aggregator.h.

                              {
            os << " " << *targetExpression;

References targetExpression.

getTargetExpression()

const Argument* souffle::ast::Aggregator::getTargetExpression ( ) const

inline

Return target expression.

Definition at line 66 of file Aggregator.h.

                                               {

print()

void souffle::ast::Aggregator::print ( std::ostream &  os ) const

inlineoverrideprotectedvirtual

Output to a given output stream.

Implements souffle::ast::Node.

Definition at line 118 of file Aggregator.h.

                                                {
        const auto& other = static_cast<const Aggregator&>(node);
        return baseOperator == other.baseOperator && equal_ptr(targetExpression, other.targetExpression) &&
               equal_targets(body, other.body);
    }

setBody()

void souffle::ast::Aggregator::setBody ( VecOwn< Literal >  bodyLiterals )

inline

Set body.

Definition at line 76 of file Aggregator.h.

                              {
            res.push_back(targetExpression.get());
        }

References targetExpression.

setFinalType()

void souffle::ast::Aggregator::setFinalType ( AggregateOp  newType )

inline

Definition at line 109 of file Aggregator.h.

         :
    void print(std::ostream& os) const override {

Field Documentation

baseOperator

AggregateOp souffle::ast::Aggregator::baseOperator

private

Aggregate (base type) operator.

Definition at line 134 of file Aggregator.h.

Referenced by Aggregator().

body

VecOwn<Literal> souffle::ast::Aggregator::body

private

Body literal of sub-query.

Definition at line 140 of file Aggregator.h.

finalTranslatorType

std::optional<AggregateOp> souffle::ast::Aggregator::finalTranslatorType

private

Definition at line 143 of file Aggregator.h.

targetExpression

Own<Argument> souffle::ast::Aggregator::targetExpression

private

Aggregate expression.

Definition at line 137 of file Aggregator.h.

Referenced by getFinalType(), and setBody().

---

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

• ast/Aggregator.h