An abstract class for performing indexed operations. More...

#include <Relation.h>

Inheritance diagram for souffle::ram::Relation:

Collaboration diagram for souffle::ram::Relation:

Public Member Functions
Relation *	clone () const override
	Create a clone (i.e. More...

unsigned	getArity () const
	Get arity of relation. More...

const std::vector< std::string > &	getAttributeNames () const
	Get attribute names. More...

const std::vector< std::string > &	getAttributeTypes () const
	Get attribute types. More...

unsigned	getAuxiliaryArity () const
	Get number of auxiliary attributes. More...

const std::string &	getName () const
	Get name. More...

RelationRepresentation	getRepresentation () const
	Relation representation type. More...

bool	isNullary () const
	Is nullary relation. More...

bool	isTemp () const
	Is temporary relation (for semi-naive evaluation) More...

bool	operator< (const Relation &other) const
	Compare two relations via their name. More...

	Relation (std::string name, size_t arity, size_t auxiliaryArity, std::vector< std::string > attributeNames, std::vector< std::string > attributeTypes, RelationRepresentation representation)

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

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

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...

void	print (std::ostream &out) const override
	Print RAM node. More...

Protected Attributes
const size_t	arity
	Arity, i.e., number of attributes. More...

const std::vector< std::string >	attributeNames
	Name of attributes. More...

const std::vector< std::string >	attributeTypes
	Type of attributes. More...

const size_t	auxiliaryArity
	Number of auxiliary attributes (e.g. More...

const std::string	name
	Name of relation. More...

const RelationRepresentation	representation
	Data-structure representation. More...

Detailed Description

An abstract class for performing indexed operations.

A RAM Relation in the RAM intermediate representation.

Index

Definition at line 40 of file Relation.h.

Constructor & Destructor Documentation

◆ Relation()

souffle::ram::Relation::Relation	(	std::string	name,
		size_t	arity,
		size_t	auxiliaryArity,
		std::vector< std::string >	attributeNames,
		std::vector< std::string >	attributeTypes,
		RelationRepresentation	representation
	)

inline

Definition at line 42 of file Relation.h.

                                               {
             assert(!this->attributeNames[i].empty() && "no attribute name specified");
             assert(!this->attributeTypes[i].empty() && "no attribute type specified");
         }
     }
  
     /** @brief Get name */
     const std::string& getName() const {
         return name;
     }

Member Function Documentation

◆ clone()

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

inlineoverridevirtual

Create a clone (i.e.

deep copy) of this node

Implements souffle::ram::Node.

Definition at line 100 of file Relation.h.

                                                {
         out << name;
         if (arity > 0) {

References arity, attributeNames, attributeTypes, i, and name.

◆ equal()

bool souffle::ram::Relation::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 123 of file Relation.h.

          :
     /** Data-structure representation */
     const RelationRepresentation representation;
  

◆ getArity()

unsigned souffle::ram::Relation::getArity ( ) const

inline

Get arity of relation.

Definition at line 86 of file Relation.h.

                                        {
         return auxiliaryArity;
     }

References auxiliaryArity.

Referenced by souffle::synthesiser::Relation::getSynthesiserRelation().

◆ getAttributeNames()

const std::vector<std::string>& souffle::ram::Relation::getAttributeNames ( ) const

inline

Get attribute names.

Definition at line 66 of file Relation.h.

                            {
         return arity == 0;
     }

References arity.

◆ getAttributeTypes()

const std::vector<std::string>& souffle::ram::Relation::getAttributeTypes ( ) const

inline

Get attribute types.

Definition at line 61 of file Relation.h.

                                                           {
         return attributeNames;
     }

References attributeNames.

◆ getAuxiliaryArity()

unsigned souffle::ram::Relation::getAuxiliaryArity ( ) const

inline

Get number of auxiliary attributes.

Definition at line 91 of file Relation.h.

                                                 {
         return name < other.name;
     }

References name.

◆ getName()

const std::string& souffle::ram::Relation::getName ( ) const

inline

Get name.

Definition at line 56 of file Relation.h.

                                                           {
         return attributeTypes;
     }

References attributeTypes.

◆ getRepresentation()

RelationRepresentation souffle::ram::Relation::getRepresentation ( ) const

inline

Relation representation type.

Definition at line 76 of file Relation.h.

                         {
         return name.at(0) == '@';
     }

References name.

Referenced by souffle::synthesiser::Relation::getSynthesiserRelation().

◆ isNullary()

bool souffle::ram::Relation::isNullary ( ) const

inline

Is nullary relation.

Definition at line 71 of file Relation.h.

                                                      {
         return representation;
     }

References representation.

Referenced by souffle::synthesiser::Relation::getSynthesiserRelation().

◆ isTemp()

bool souffle::ram::Relation::isTemp ( ) const

inline

Is temporary relation (for semi-naive evaluation)

Definition at line 81 of file Relation.h.

                               {
         return arity;
     }

References arity.

◆ operator<()

bool souffle::ram::Relation::operator< ( const Relation & other ) const

inline

Compare two relations via their name.

Definition at line 96 of file Relation.h.

99 :

100 void print(std::ostream& out) const override {

◆ print()

void souffle::ram::Relation::print ( std::ostream & out ) const

inlineoverrideprotectedvirtual

Print RAM node.

Implements souffle::ram::Node.

Definition at line 105 of file Relation.h.

                                              :" << attributeTypes[i];
                 if (i >= arity - auxiliaryArity) {
                     out << " auxiliary";
                 }
             }
             out << ")";
             out << " " << representation;
         } else {
             out << " nullary";
         }
     }
  
     bool equal(const Node& node) const override {
         assert(isA<Relation>(&node));
         const auto& other = static_cast<const Relation&>(node);
         return representation == other.representation && name == other.name && arity == other.arity &&

Field Documentation

◆ arity

const size_t souffle::ram::Relation::arity

protected

Arity, i.e., number of attributes.

Definition at line 139 of file Relation.h.

Referenced by clone(), getAttributeNames(), and isTemp().

◆ attributeNames

const std::vector<std::string> souffle::ram::Relation::attributeNames

protected

Name of attributes.

Definition at line 145 of file Relation.h.

Referenced by clone(), and getAttributeTypes().

◆ attributeTypes

const std::vector<std::string> souffle::ram::Relation::attributeTypes

protected

Type of attributes.

Definition at line 148 of file Relation.h.

Referenced by clone(), and getName().

◆ auxiliaryArity

const size_t souffle::ram::Relation::auxiliaryArity

protected

Number of auxiliary attributes (e.g.

provenance attributes etc)

Definition at line 142 of file Relation.h.

Referenced by getArity().

◆ name

const std::string souffle::ram::Relation::name

protected

Name of relation.

Definition at line 136 of file Relation.h.

Referenced by clone(), getAuxiliaryArity(), and getRepresentation().

◆ representation

const RelationRepresentation souffle::ram::Relation::representation

protected

Data-structure representation.

Definition at line 133 of file Relation.h.

Referenced by isNullary().

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

ram/Relation.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Relation()

Member Function Documentation

◆ clone()

◆ equal()

◆ getArity()

◆ getAttributeNames()

◆ getAttributeTypes()

◆ getAuxiliaryArity()

◆ getName()

◆ getRepresentation()

◆ isNullary()

◆ isTemp()

◆ operator<()

◆ print()

Field Documentation

◆ arity

◆ attributeNames

◆ attributeTypes

◆ auxiliaryArity

◆ name

◆ representation