#include <IndexOperation.h>

Inheritance diagram for souffle::ram::IndexOperation:

Collaboration diagram for souffle::ram::IndexOperation:

Public Member Functions
void	apply (const NodeMapper &map) override
	Apply the mapper to all child nodes. More...

IndexOperation *	clone () const override
	Create a clone (i.e. More...

std::vector< const Node * >	getChildNodes () const override
	Obtain list of all embedded child nodes. More...

std::pair< std::vector< Expression * >, std::vector< Expression * > >	getRangePattern () const
	Get range pattern. More...

	IndexOperation (std::string rel, int ident, RamPattern queryPattern, Own< Operation > nested, std::string profileText="")

void	printIndex (std::ostream &os) const
	Helper method for printing. More...

Public Member Functions inherited from souffle::ram::RelationOperation
const std::string &	getRelation () const
	Get search relation. More...

	RelationOperation (std::string rel, int ident, Own< Operation > nested, std::string profileText="")

Public Member Functions inherited from souffle::ram::TupleOperation
std::vector< const Node * >	getChildNodes () const override
	Obtain list of all embedded child nodes. More...

int	getTupleId () const
	Get identifier. More...

void	setTupleId (int id)
	Set identifier. More...

	TupleOperation (int ident, Own< Operation > nested, std::string profileText="")

Public Member Functions inherited from souffle::ram::NestedOperation
void	apply (const NodeMapper &map) override
	Apply the mapper to all child nodes. More...

Operation &	getOperation () const
	Get nested operation. More...

const std::string &	getProfileText () const
	Get profile text. More...

	NestedOperation (Own< Operation > nested, std::string profileText="")

Public Member Functions inherited from souffle::ram::Node
bool	operator!= (const Node &other) const
	Inequality check for two RAM nodes. More...

bool	operator== (const Node &other) const
	Equivalence check for two RAM nodes. More...

virtual void	rewrite (const Node *oldNode, Own< Node > newNode)
	Rewrite a child node. More...

virtual	~Node ()=default

Protected Member Functions
bool	equal (const Node &node) const override
	Equality check for two RAM nodes. More...

Protected Member Functions inherited from souffle::ram::RelationOperation
bool	equal (const Node &node) const override
	Equality check for two RAM nodes. More...

Protected Member Functions inherited from souffle::ram::TupleOperation
bool	equal (const Node &node) const override
	Equality check for two RAM nodes. More...

Protected Member Functions inherited from souffle::ram::NestedOperation
void	print (std::ostream &os, int tabpos) const override
	Pretty print with indentation. More...

Protected Member Functions inherited from souffle::ram::Operation
void	print (std::ostream &os) const override
	Print RAM node. More...

Protected Attributes
RamPattern	queryPattern
	Values of index per column of table (if indexable) More...

Protected Attributes inherited from souffle::ram::RelationOperation
const std::string	relation
	Search relation. More...

Protected Attributes inherited from souffle::ram::TupleOperation
int	identifier
	Identifier for the tuple, corresponding to its position in the loop nest. More...

Protected Attributes inherited from souffle::ram::NestedOperation
Own< Operation >	nestedOperation
	Nested operation. More...

const std::string	profileText
	Text used by the profiler. More...

Additional Inherited Members
Static Protected Member Functions inherited from souffle::ram::Operation
static void	print (const Operation *operation, std::ostream &os, int tabpos)
	Pretty print jump-bed. More...

Detailed Description

Definition at line 48 of file IndexOperation.h.

Constructor & Destructor Documentation

◆ IndexOperation()

souffle::ram::IndexOperation::IndexOperation	(	std::string	rel,
		int	ident,
		RamPattern	queryPattern,
		Own< Operation >	nested,
		std::string	profileText = `""`
	)

inline

Definition at line 50 of file IndexOperation.h.

                                  : queryPattern.first) {
             assert(pattern != nullptr && "pattern is a null-pointer");
         }
         for (const auto& pattern : queryPattern.second) {
             assert(pattern != nullptr && "pattern is a null-pointer");
         }
     }
  
     /**
      * @brief Get range pattern
      * @return A pair of std::vector of pointers to Expression objects

Member Function Documentation

◆ apply()

void souffle::ram::IndexOperation::apply ( const NodeMapper & )

inlineoverridevirtual

Apply the mapper to all child nodes.

Reimplemented from souffle::ram::Node.

Definition at line 85 of file IndexOperation.h.

                            : queryPattern.second) {
             pattern = map(std::move(pattern));
         }
     }
  
     IndexOperation* clone() const override {
         RamPattern resQueryPattern;
         for (const auto& i : queryPattern.first) {

◆ clone()

IndexOperation* souffle::ram::IndexOperation::clone ( ) const

inlineoverridevirtual

Create a clone (i.e.

deep copy) of this node

Implements souffle::ram::RelationOperation.

Reimplemented in souffle::ram::ParallelIndexChoice, souffle::ram::ParallelIndexScan, souffle::ram::IndexScan, and souffle::ram::ParallelIndexAggregate.

Definition at line 95 of file IndexOperation.h.

                            : queryPattern.second) {
             resQueryPattern.second.emplace_back(i->clone());
         }
         return new IndexOperation(relation, getTupleId(), std::move(resQueryPattern),
                 souffle::clone(&getOperation()), getProfileText());
     }
  
     /** @brief Helper method for printing */
     void printIndex(std::ostream& os) const {
         //  const auto& attrib = getRelation().getAttributeNames();

◆ equal()

bool souffle::ram::IndexOperation::equal ( const Node & ) const

inlineoverrideprotectedvirtual

Equality check for two RAM nodes.

Default action is that nothing needs to be checked.

Reimplemented from souffle::ram::Node.

Definition at line 153 of file IndexOperation.h.

◆ getChildNodes()

std::vector<const Node*> souffle::ram::IndexOperation::getChildNodes ( ) const

inlineoverridevirtual

Obtain list of all embedded child nodes.

Reimplemented from souffle::ram::Node.

Definition at line 74 of file IndexOperation.h.

                            : queryPattern.second) {
             res.push_back(pattern.get());
         }
         return res;
     }
  
     void apply(const NodeMapper& map) override {
         RelationOperation::apply(map);
         for (auto& pattern : queryPattern.first) {

Referenced by souffle::ram::IndexAggregate::IndexAggregate().

◆ getRangePattern()

std::pair<std::vector<Expression*>, std::vector<Expression*> > souffle::ram::IndexOperation::getRangePattern ( ) const

inline

Get range pattern.

Returns: A pair of std::vector of pointers to Expression objects These vectors represent the lower and upper bounds for each attribute in the tuple <expr1> <= Tuple[level, element] <= <expr2> We have that at an index for an attribute, its bounds are <expr1> and <expr2> respectively

Definition at line 70 of file IndexOperation.h.

                                                           {
         auto res = RelationOperation::getChildNodes();
         for (auto& pattern : queryPattern.first) {

References souffle::ram::TupleOperation::getChildNodes(), and queryPattern.

Referenced by souffle::ram::IndexChoice::IndexChoice().

Here is the call graph for this function:

◆ printIndex()

void souffle::ram::IndexOperation::printIndex ( std::ostream & os ) const

inline

Helper method for printing.

Definition at line 108 of file IndexOperation.h.

                                                                                                          {
                 continue;
             }
  
             if (first) {
                 os << " ON INDEX ";
                 first = false;
             } else {
                 os << " AND ";
             }
  
             // both bounds defined and equal => equality
             if (!isUndefValue(queryPattern.first[i].get()) && !isUndefValue(queryPattern.second[i].get())) {
                 // print equality when lower bound = upper bound
                 if (*(queryPattern.first[i]) == *(queryPattern.second[i])) {
                     os << "t" << getTupleId() << ".";
                     os << i << " = ";
                     os << *(queryPattern.first[i]);
                     continue;
                 }
             }
             // at least one bound defined => inequality
             if (!isUndefValue(queryPattern.first[i].get()) || !isUndefValue(queryPattern.second[i].get())) {
                 if (!isUndefValue(queryPattern.first[i].get())) {
                     os << *(queryPattern.first[i]) << " <= ";
                 }
  
                 os << "t" << getTupleId() << ".";
                 os << i;
  
                 if (!isUndefValue(queryPattern.second[i].get())) {
                     os << " <= " << *(queryPattern.second[i]);
                 }
  
                 continue;
             }
         }
     }
  
 protected:
     bool equal(const Node& node) const override {
         const auto& other = static_cast<const IndexOperation&>(node);

Field Documentation

◆ queryPattern

RamPattern souffle::ram::IndexOperation::queryPattern

protected

Values of index per column of table (if indexable)

Definition at line 161 of file IndexOperation.h.

Referenced by getRangePattern(), souffle::ram::IndexScan::IndexScan(), souffle::ram::ParallelIndexAggregate::ParallelIndexAggregate(), souffle::ram::ParallelIndexChoice::ParallelIndexChoice(), and souffle::ram::ParallelIndexScan::ParallelIndexScan().

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

ram/IndexOperation.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IndexOperation()

Member Function Documentation

◆ apply()

◆ clone()

◆ equal()

◆ getChildNodes()

◆ getRangePattern()

◆ printIndex()

Field Documentation

◆ queryPattern