souffle::ast::Atom Class Reference

An atom class. More...

#include <Atom.h>

Inheritance diagram for souffle::ast::Atom:

Collaboration diagram for souffle::ast::Atom:

Public Member Functions
void	addArgument (Own< Argument > arg)
	Add argument to the atom. More...
void	apply (const NodeMapper &map) override
	Apply the mapper to all child nodes. More...
	Atom (QualifiedName name={}, VecOwn< Argument > args={}, SrcLocation loc={})
Atom *	clone () const override
	Create a clone (i.e. More...
std::vector< Argument * >	getArguments () const
	Return arguments. More...
size_t	getArity () const
	Return arity of the atom. More...
std::vector< const Node * >	getChildNodes () const override
	Obtain a list of all embedded AST child nodes. More...
const QualifiedName &	getQualifiedName () const
	Return qualified name. More...
void	setQualifiedName (QualifiedName n)
	Set qualified name. More...
Public Member Functions inherited from souffle::ast::Literal
	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...

Protected Attributes
VecOwn< Argument >	arguments
	Arguments of atom. More...
QualifiedName	name
	Name of atom. More...

Detailed Description

An atom class.

An atom representing the use of a relation either in the head or in the body of a clause, e.g., parent(x,y), !parent(x,y), ...

Definition at line 51 of file Atom.h.

Constructor & Destructor Documentation

Atom()

souffle::ast::Atom::Atom ( QualifiedName  name = {}, VecOwn< Argument >  args = {}, SrcLocation  loc = {}  )

inline

Definition at line 53 of file Atom.h.

                            {

Member Function Documentation

addArgument()

void souffle::ast::Atom::addArgument ( Own< Argument >  arg )

inline

Add argument to the atom.

Definition at line 72 of file Atom.h.

                                 {

apply()

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

inlineoverridevirtual

Apply the mapper to all child nodes.

Reimplemented from souffle::ast::Node.

Definition at line 85 of file Atom.h.

                                                          {
        std::vector<const Node*> res;
        for (auto& cur : arguments) {
            res.push_back(cur.get());
        }

References arguments.

clone()

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

inlineoverridevirtual

Create a clone (i.e.

deep copy) of this node

Implements souffle::ast::Literal.

Definition at line 81 of file Atom.h.

equal()

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

inlineoverrideprotectedvirtual

Abstract equality check for two AST nodes.

Reimplemented from souffle::ast::Node.

Definition at line 104 of file Atom.h.

getArguments()

std::vector<Argument*> souffle::ast::Atom::getArguments ( ) const

inline

Return arguments.

Definition at line 77 of file Atom.h.

                                               {

Referenced by souffle::ast::transform::MagicSetTransformer::MagicSetCoreTransformer::getMagicName(), souffle::ast::transform::RemoveRelationCopiesTransformer::removeRelationCopies(), and souffle::ast2ram::ClauseTranslator::translateClause().

getArity()

size_t souffle::ast::Atom::getArity ( ) const

inline

Return arity of the atom.

Definition at line 62 of file Atom.h.

                                        {

getChildNodes()

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

inlineoverridevirtual

Obtain a list of all embedded AST child nodes.

Reimplemented from souffle::ast::Node.

Definition at line 91 of file Atom.h.

         :
    void print(std::ostream& os) const override {
        os << getQualifiedName() << "(" << join(arguments) << ")";
    }
 

getQualifiedName()

const QualifiedName& souffle::ast::Atom::getQualifiedName ( ) const

inline

Return qualified name.

Definition at line 57 of file Atom.h.

                                           {

Referenced by souffle::ast::transform::MagicSetTransformer::MagicSetCoreTransformer::getMagicName(), souffle::ast::transform::RemoveRelationCopiesTransformer::removeRelationCopies(), and souffle::ast::removeRelationIOs().

print()

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

inlineoverrideprotectedvirtual

Output to a given output stream.

Implements souffle::ast::Node.

Definition at line 100 of file Atom.h.

setQualifiedName()

void souffle::ast::Atom::setQualifiedName ( QualifiedName  n )

inline

Set qualified name.

Definition at line 67 of file Atom.h.

Field Documentation

arguments

VecOwn<Argument> souffle::ast::Atom::arguments

protected

Arguments of atom.

Definition at line 113 of file Atom.h.

Referenced by apply().

name

QualifiedName souffle::ast::Atom::name

protected

Name of atom.

Definition at line 110 of file Atom.h.

---

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

• ast/Atom.h