#include <Relation.h>

Collaboration diagram for souffle::synthesiser::Relation:

Public Member Functions
virtual void	computeIndices ()=0
	Compute the final list of indices to be used. More...

virtual void	generateTypeStruct (std::ostream &out)=0
	Generate relation type struct. More...

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

const std::string &	getDataStructure () const
	Get data structure of relation. More...

MinIndexSelection::OrderCollection	getIndices () const
	Get list of indices used for relation, guaranteed that original indices in analysis::MinIndexSelection come before any generated indices. More...

const MinIndexSelection &	getMinIndexSelection () const
	Get stored analysis::MinIndexSelection. More...

std::set< int >	getProvenenceIndexNumbers () const

const ram::Relation &	getRelation () const
	Get stored ram::Relation. More...

std::string	getTypeAttributeString (const std::vector< std::string > &attributeTypes, const std::unordered_set< uint32_t > &attributesUsed) const
	Helper function to convert attribute types to a single string. More...

virtual std::string	getTypeName ()=0
	Print type name. More...

	Relation (const ram::Relation &rel, const MinIndexSelection &indices, const bool isProvenance=false)

virtual	~Relation ()=default

Static Public Member Functions
static Own< Relation >	getSynthesiserRelation (const ram::Relation &ramRel, const MinIndexSelection &indexSet, bool isProvenance)
	Factory method to generate a SynthesiserRelation. More...

Protected Attributes
MinIndexSelection::OrderCollection	computedIndices
	The final list of indices used. More...

std::string	dataStructure
	The data structure used for the relation. More...

const MinIndexSelection &	indices
	Indices used for this relation. More...

const bool	isProvenance
	Is this relation used with provenance. More...

size_t	masterIndex = -1
	The number of the master index. More...

std::set< int >	provenanceIndexNumbers
	The list of indices added for provenance computation. More...

const ram::Relation &	relation
	Ram relation referred to by this. More...

Detailed Description

Definition at line 26 of file Relation.h.

Constructor & Destructor Documentation

◆ Relation()

souffle::synthesiser::Relation::Relation	(	const ram::Relation &	rel,
		const MinIndexSelection &	indices,
		const bool	isProvenance = `false`
	)

inline

Definition at line 28 of file Relation.h.

29 : relation(rel), indices(indices), isProvenance(isProvenance) {}

References isProvenance.

◆ ~Relation()

virtual souffle::synthesiser::Relation::~Relation ( )

virtualdefault

Member Function Documentation

◆ computeIndices()

virtual void souffle::synthesiser::Relation::computeIndices ( )

pure virtual

Compute the final list of indices to be used.

◆ generateTypeStruct()

virtual void souffle::synthesiser::Relation::generateTypeStruct ( std::ostream & out )

pure virtual

Generate relation type struct.

◆ getArity()

size_t souffle::synthesiser::Relation::getArity ( ) const

inline

Get arity of relation.

Definition at line 37 of file Relation.h.

                             {
         return relation.getArity();
     }

References relation.

◆ getDataStructure()

const std::string& souffle::synthesiser::Relation::getDataStructure ( ) const

inline

Get data structure of relation.

Definition at line 42 of file Relation.h.

                                               {
         return dataStructure;
     }

References dataStructure.

◆ getIndices()

MinIndexSelection::OrderCollection souffle::synthesiser::Relation::getIndices ( ) const

inline

Get list of indices used for relation, guaranteed that original indices in analysis::MinIndexSelection come before any generated indices.

Definition at line 49 of file Relation.h.

                                                         {
         return computedIndices;
     }

References computedIndices.

◆ getMinIndexSelection()

const MinIndexSelection& souffle::synthesiser::Relation::getMinIndexSelection ( ) const

inline

Get stored analysis::MinIndexSelection.

Definition at line 58 of file Relation.h.

                                                           {
         return indices;
     }

References indices.

◆ getProvenenceIndexNumbers()

std::set<int> souffle::synthesiser::Relation::getProvenenceIndexNumbers ( ) const

inline

Definition at line 53 of file Relation.h.

                                                   {
         return provenanceIndexNumbers;
     }

References provenanceIndexNumbers.

◆ getRelation()

const ram::Relation& souffle::synthesiser::Relation::getRelation ( ) const

inline

Get stored ram::Relation.

Definition at line 63 of file Relation.h.

                                            {
         return relation;
     }

References relation.

◆ getSynthesiserRelation()

Own< Relation > souffle::synthesiser::Relation::getSynthesiserRelation	(	const ram::Relation &	ramRel,
		const MinIndexSelection &	indexSet,
		bool	isProvenance
	)

static

Factory method to generate a SynthesiserRelation.

Definition at line 45 of file Relation.cpp.

                                                                                          {
     Relation* rel;
  
     // Handle the qualifier in souffle code
     if (isProvenance) {
         rel = new DirectRelation(ramRel, indexSet, isProvenance);
     } else if (ramRel.isNullary()) {
         rel = new NullaryRelation(ramRel, indexSet, isProvenance);
     } else if (ramRel.getRepresentation() == RelationRepresentation::BTREE) {
         rel = new DirectRelation(ramRel, indexSet, isProvenance);
     } else if (ramRel.getRepresentation() == RelationRepresentation::BRIE) {
         rel = new BrieRelation(ramRel, indexSet, isProvenance);
     } else if (ramRel.getRepresentation() == RelationRepresentation::EQREL) {
         rel = new EqrelRelation(ramRel, indexSet, isProvenance);
     } else if (ramRel.getRepresentation() == RelationRepresentation::INFO) {
         rel = new InfoRelation(ramRel, indexSet, isProvenance);
     } else {
         // Handle the data structure command line flag
         if (ramRel.getArity() > 6) {
             rel = new IndirectRelation(ramRel, indexSet, isProvenance);
         } else {
             rel = new DirectRelation(ramRel, indexSet, isProvenance);
         }
     }
  
     assert(rel != nullptr && "relation type not specified");
     // generate index set
     rel->computeIndices();
  
     return Own<Relation>(rel);
 }

References souffle::BRIE, souffle::BTREE, souffle::EQREL, souffle::ram::Relation::getArity(), souffle::ram::Relation::getRepresentation(), souffle::INFO, souffle::ram::Relation::isNullary(), and rel().

Here is the call graph for this function:

◆ getTypeAttributeString()

std::string souffle::synthesiser::Relation::getTypeAttributeString	(	const std::vector< std::string > &	attributeTypes,
		const std::unordered_set< uint32_t > &	attributesUsed
	)		const

Helper function to convert attribute types to a single string.

Definition at line 29 of file Relation.cpp.

                                                                 {
     std::stringstream type;
     for (size_t i = 0; i < attributeTypes.size(); ++i) {
         // consider only attributes used in a lex-order
         if (attributesUsed.find(i) != attributesUsed.end()) {
             switch (attributeTypes[i][0]) {
                 case 'f': type << 'f'; break;
                 case 'u': type << 'u'; break;
                 default: type << 'i';  // consider all non-float/unsigned types (i.e. records) as RamSigned
             }
         }
     }
     return type.str();
 }

References i.

◆ getTypeName()

virtual std::string souffle::synthesiser::Relation::getTypeName ( )

pure virtual

Print type name.

Field Documentation

◆ computedIndices

MinIndexSelection::OrderCollection souffle::synthesiser::Relation::computedIndices

protected

The final list of indices used.

Definition at line 92 of file Relation.h.

Referenced by getIndices().

◆ dataStructure

std::string souffle::synthesiser::Relation::dataStructure

protected

The data structure used for the relation.

Definition at line 89 of file Relation.h.

Referenced by getDataStructure().

◆ indices

const MinIndexSelection& souffle::synthesiser::Relation::indices

protected

Indices used for this relation.

Definition at line 86 of file Relation.h.

Referenced by getMinIndexSelection().

◆ isProvenance

const bool souffle::synthesiser::Relation::isProvenance

protected

Is this relation used with provenance.

Definition at line 101 of file Relation.h.

Referenced by Relation().

◆ masterIndex

size_t souffle::synthesiser::Relation::masterIndex = -1

protected

The number of the master index.

Definition at line 98 of file Relation.h.

◆ provenanceIndexNumbers

std::set<int> souffle::synthesiser::Relation::provenanceIndexNumbers

protected

The list of indices added for provenance computation.

Definition at line 95 of file Relation.h.

Referenced by getProvenenceIndexNumbers().

◆ relation

const ram::Relation& souffle::synthesiser::Relation::relation

protected

Ram relation referred to by this.

Definition at line 83 of file Relation.h.

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

synthesiser/Relation.h
synthesiser/Relation.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Relation()

◆ ~Relation()

Member Function Documentation

◆ computeIndices()

◆ generateTypeStruct()

◆ getArity()

◆ getDataStructure()

◆ getIndices()

◆ getMinIndexSelection()

◆ getProvenenceIndexNumbers()

◆ getRelation()

◆ getSynthesiserRelation()

◆ getTypeAttributeString()

◆ getTypeName()

Field Documentation

◆ computedIndices

◆ dataStructure

◆ indices

◆ isProvenance

◆ masterIndex

◆ provenanceIndexNumbers

◆ relation