#include <EquivalenceRelation.h>

Collaboration diagram for souffle::EquivalenceRelation< TupleType >::iterator:

Public Types
using	difference_type = ptrdiff_t

typedef std::forward_iterator_tag	iterator_category

using	pointer = value_type *

using	reference = value_type &

using	value_type = TupleType

Public Member Functions
	iterator (const EquivalenceRelation *br)

	iterator (const EquivalenceRelation *br, bool)

	iterator (const EquivalenceRelation *br, const StatesBucket within)

	iterator (const EquivalenceRelation *br, const typename TupleType::value_type former, const StatesBucket within)

	iterator (const EquivalenceRelation *br, const typename TupleType::value_type former, typename TupleType::value_type latter, const StatesBucket within)

	iterator (const iterator &other)=default

	iterator (iterator &&other)=default

bool	operator!= (const iterator &other) const

const TupleType &	operator* () const

iterator &	operator++ ()

const TupleType *	operator-> () const

iterator &	operator= (const iterator &other)=default

bool	operator== (const iterator &other) const

void	setAnterior (const typename TupleType::value_type a)
	explicit set first half of cPair More...

void	setPosterior (const typename TupleType::value_type b)
	explicit set second half of cPair More...

void	updateAnterior ()
	quick update to whatever the current index is pointing to More...

void	updatePosterior ()
	quick update to whatever the current index is pointing to More...

Private Types
enum	IterType { ALL, ANTERIOR, ANTPOST, WITHIN }

Private Attributes
const EquivalenceRelation *	br = nullptr

size_t	cAnteriorIndex = 0

TupleType	cPair

size_t	cPosteriorIndex = 0

StatesBucket	djSetList

StatesMap::iterator	djSetMapListEnd

StatesMap::iterator	djSetMapListIt

bool	isEndVal = false

IterType	ityp

Detailed Description

template<typename TupleType>
class souffle::EquivalenceRelation< TupleType >::iterator

Definition at line 261 of file EquivalenceRelation.h.

Member Typedef Documentation

◆ difference_type

template<typename TupleType >

using souffle::EquivalenceRelation< TupleType >::iterator::difference_type = ptrdiff_t

Definition at line 265 of file EquivalenceRelation.h.

◆ iterator_category

template<typename TupleType >

typedef std::forward_iterator_tag souffle::EquivalenceRelation< TupleType >::iterator::iterator_category

Definition at line 263 of file EquivalenceRelation.h.

◆ pointer

template<typename TupleType >

using souffle::EquivalenceRelation< TupleType >::iterator::pointer = value_type*

Definition at line 266 of file EquivalenceRelation.h.

◆ reference

template<typename TupleType >

using souffle::EquivalenceRelation< TupleType >::iterator::reference = value_type&

Definition at line 267 of file EquivalenceRelation.h.

◆ value_type

template<typename TupleType >

using souffle::EquivalenceRelation< TupleType >::iterator::value_type = TupleType

Definition at line 264 of file EquivalenceRelation.h.

Member Enumeration Documentation

◆ IterType

template<typename TupleType >

enum souffle::EquivalenceRelation::iterator::IterType

private

Enumerator
ALL
ANTERIOR
ANTPOST
WITHIN

Definition at line 459 of file EquivalenceRelation.h.

459 :

460 /**

Constructor & Destructor Documentation

◆ iterator() [1/7]

template<typename TupleType >

souffle::EquivalenceRelation< TupleType >::iterator::iterator	(	const EquivalenceRelation *	br,
		bool
	)

inlineexplicit

Definition at line 270 of file EquivalenceRelation.h.

275 : br(br), ityp(IterType::WITHIN), djSetList(within) {

Referenced by souffle::EquivalenceRelation< Arity >::size().

◆ iterator() [2/7]

template<typename TupleType >

souffle::EquivalenceRelation< TupleType >::iterator::iterator ( const EquivalenceRelation * br )

inlineexplicit

Definition at line 273 of file EquivalenceRelation.h.

                 : br(br), ityp(IterType::WITHIN), djSetList(within) {
             // empty dj set
             if (djSetList->size() == 0) {
                 isEndVal = true;
             }
  
             updateAnterior();
             updatePosterior();
         }
  
         // ANTERIOR: iterator that yields all (former, _) \in djset(former) (djset(former) === within)
         explicit iterator(const EquivalenceRelation* br, const typename TupleType::value_type former,
                 const StatesBucket within)

References souffle::EquivalenceRelation< TupleType >::iterator::djSetList, souffle::EquivalenceRelation< TupleType >::iterator::isEndVal, souffle::PiggyList< T >::size(), souffle::EquivalenceRelation< TupleType >::iterator::updateAnterior(), and souffle::EquivalenceRelation< TupleType >::iterator::updatePosterior().

Here is the call graph for this function:

◆ iterator() [3/7]

template<typename TupleType >

souffle::EquivalenceRelation< TupleType >::iterator::iterator	(	const EquivalenceRelation *	br,
		const StatesBucket	within
	)

inlineexplicit

Definition at line 290 of file EquivalenceRelation.h.

◆ iterator() [4/7]

template<typename TupleType >

souffle::EquivalenceRelation< TupleType >::iterator::iterator	(	const EquivalenceRelation *	br,
		const typename TupleType::value_type	former,
		const StatesBucket	within
	)

inlineexplicit

Definition at line 302 of file EquivalenceRelation.h.

                                         {
                 isEndVal = true;
             }
  
             setAnterior(former);
             setPosterior(latter);
         }
  
         /** explicit set first half of cPair */
         inline void setAnterior(const typename TupleType::value_type a) {

References souffle::EquivalenceRelation< TupleType >::iterator::isEndVal.

◆ iterator() [5/7]

template<typename TupleType >

souffle::EquivalenceRelation< TupleType >::iterator::iterator	(	const EquivalenceRelation *	br,
		const typename TupleType::value_type	former,
		typename TupleType::value_type	latter,
		const StatesBucket	within
	)

inlineexplicit

Definition at line 315 of file EquivalenceRelation.h.

                                      {
             this->cPair[0] = this->djSetList->get(this->cAnteriorIndex);
         }
  
         /** explicit set second half of cPair */
         inline void setPosterior(const typename TupleType::value_type b) {
             this->cPair[1] = b;
         }
  

References souffle::EquivalenceRelation< TupleType >::iterator::cAnteriorIndex, souffle::EquivalenceRelation< TupleType >::iterator::cPair, souffle::EquivalenceRelation< TupleType >::iterator::djSetList, and souffle::PiggyList< T >::get().

Here is the call graph for this function:

◆ iterator() [6/7]

template<typename TupleType >

souffle::EquivalenceRelation< TupleType >::iterator::iterator ( const iterator & other )

default

◆ iterator() [7/7]

template<typename TupleType >

souffle::EquivalenceRelation< TupleType >::iterator::iterator ( iterator && other )

default

Member Function Documentation

◆ operator!=()

template<typename TupleType >

bool souffle::EquivalenceRelation< TupleType >::iterator::operator!= ( const iterator & other ) const

inline

Definition at line 358 of file EquivalenceRelation.h.

360 {

◆ operator*()

template<typename TupleType >

const TupleType& souffle::EquivalenceRelation< TupleType >::iterator::operator* ( ) const

inline

Definition at line 362 of file EquivalenceRelation.h.

364 {

◆ operator++()

template<typename TupleType >

iterator& souffle::EquivalenceRelation< TupleType >::iterator::operator++ ( )

inline

Definition at line 371 of file EquivalenceRelation.h.

                                                         {
                                 throw std::out_of_range("error: encountered a zero size djset");
                             }
  
                             // update our cAnterior and cPosterior
                             cAnteriorIndex = 0;
                             cPosteriorIndex = 0;
                             updateAnterior();
                             updatePosterior();
                         }
  
                         // we moved our anterior along one
                         updateAnterior();
  
                         cPosteriorIndex = 0;
                         updatePosterior();
                     }
                     // we just moved our posterior along one
                     updatePosterior();
  
                     break;
                 case IterType::ANTERIOR:
                     // step posterior along one, and if we can't, then we're done.
                     if (++cPosteriorIndex == djSetList->size()) {
                         isEndVal = true;
                         return *this;
                     }
                     updatePosterior();
  
                     break;
                 case IterType::ANTPOST:
                     // fixed anterior and posterior literally only points to one, so if we increment, its the
                     // end
                     isEndVal = true;
                     break;
                 case IterType::WITHIN:
                     // move posterior along one
                     // see if we can't move the posterior along
                     if (++cPosteriorIndex == djSetList->size()) {
                         // move anterior along one
                         // see if we can't move the anterior along one
                         if (++cAnteriorIndex == djSetList->size()) {
                             isEndVal = true;
                             return *this;
                         }
  
                         // we moved our anterior along one
                         updateAnterior();
  
                         cPosteriorIndex = 0;
                         updatePosterior();
                     }
                     // we just moved our posterior along one
                     updatePosterior();
                     break;
             }
  
             return *this;
         }
  
     private:
         const EquivalenceRelation* br = nullptr;
         // special tombstone value to notify that this iter represents the end
         bool isEndVal = false;
  
         // all the different types of iterator this can be
         enum IterType { ALL, ANTERIOR, ANTPOST, WITHIN };
         IterType ityp;
  
         TupleType cPair;
  
         // the disjoint set that we're currently iterating through
         StatesBucket djSetList;
         typename StatesMap::iterator djSetMapListIt;
         typename StatesMap::iterator djSetMapListEnd;

◆ operator->()

template<typename TupleType >

const TupleType* souffle::EquivalenceRelation< TupleType >::iterator::operator-> ( ) const

inline

Definition at line 366 of file EquivalenceRelation.h.

367 {

368 // move the djset it along one

References souffle::EquivalenceRelation< TupleType >::iterator::djSetMapListEnd, and souffle::EquivalenceRelation< TupleType >::iterator::djSetMapListIt.

◆ operator=()

template<typename TupleType >

iterator& souffle::EquivalenceRelation< TupleType >::iterator::operator= ( const iterator & other )

default

◆ operator==()

template<typename TupleType >

bool souffle::EquivalenceRelation< TupleType >::iterator::operator== ( const iterator & other ) const

inline

Definition at line 353 of file EquivalenceRelation.h.

355 {

356 if (isEndVal) {

References souffle::EquivalenceRelation< TupleType >::iterator::isEndVal.

◆ setAnterior()

template<typename TupleType >

void souffle::EquivalenceRelation< TupleType >::iterator::setAnterior ( const typename TupleType::value_type a )

inline

explicit set first half of cPair

Definition at line 327 of file EquivalenceRelation.h.

337 {

◆ setPosterior()

template<typename TupleType >

void souffle::EquivalenceRelation< TupleType >::iterator::setPosterior ( const typename TupleType::value_type b )

inline

explicit set second half of cPair

Definition at line 337 of file EquivalenceRelation.h.

                                                      {
             if (isEndVal && other.isEndVal) return br == other.br;
             return isEndVal == other.isEndVal && cPair == other.cPair;

References souffle::EquivalenceRelation< TupleType >::iterator::br, souffle::EquivalenceRelation< TupleType >::iterator::cPair, and souffle::EquivalenceRelation< TupleType >::iterator::isEndVal.

◆ updateAnterior()

template<typename TupleType >

void souffle::EquivalenceRelation< TupleType >::iterator::updateAnterior ( )

inline

quick update to whatever the current index is pointing to

Definition at line 332 of file EquivalenceRelation.h.

337 {

Referenced by souffle::EquivalenceRelation< TupleType >::iterator::iterator().

◆ updatePosterior()

template<typename TupleType >

void souffle::EquivalenceRelation< TupleType >::iterator::updatePosterior ( )

inline

quick update to whatever the current index is pointing to

Definition at line 342 of file EquivalenceRelation.h.

                                                      {
             return !((*this) == other);
         }

Referenced by souffle::EquivalenceRelation< TupleType >::iterator::iterator().

Field Documentation

◆ br

template<typename TupleType >

const EquivalenceRelation* souffle::EquivalenceRelation< TupleType >::iterator::br = nullptr

private

Definition at line 454 of file EquivalenceRelation.h.

Referenced by souffle::EquivalenceRelation< TupleType >::iterator::setPosterior(), and souffle::EquivalenceRelation< Arity >::size().

◆ cAnteriorIndex

template<typename TupleType >

size_t souffle::EquivalenceRelation< TupleType >::iterator::cAnteriorIndex = 0

private

Definition at line 470 of file EquivalenceRelation.h.

Referenced by souffle::EquivalenceRelation< TupleType >::iterator::iterator().

◆ cPair

template<typename TupleType >

TupleType souffle::EquivalenceRelation< TupleType >::iterator::cPair

private

Definition at line 462 of file EquivalenceRelation.h.

Referenced by souffle::EquivalenceRelation< TupleType >::iterator::iterator(), and souffle::EquivalenceRelation< TupleType >::iterator::setPosterior().

◆ cPosteriorIndex

template<typename TupleType >

size_t souffle::EquivalenceRelation< TupleType >::iterator::cPosteriorIndex = 0

private

Definition at line 472 of file EquivalenceRelation.h.

◆ djSetList

template<typename TupleType >

StatesBucket souffle::EquivalenceRelation< TupleType >::iterator::djSetList

private

Definition at line 465 of file EquivalenceRelation.h.

Referenced by souffle::EquivalenceRelation< TupleType >::iterator::iterator().

◆ djSetMapListEnd

template<typename TupleType >

StatesMap::iterator souffle::EquivalenceRelation< TupleType >::iterator::djSetMapListEnd

private

Definition at line 467 of file EquivalenceRelation.h.

Referenced by souffle::EquivalenceRelation< TupleType >::iterator::operator->(), and souffle::EquivalenceRelation< Arity >::size().

◆ djSetMapListIt

template<typename TupleType >

StatesMap::iterator souffle::EquivalenceRelation< TupleType >::iterator::djSetMapListIt

private

Definition at line 466 of file EquivalenceRelation.h.

Referenced by souffle::EquivalenceRelation< TupleType >::iterator::operator->(), and souffle::EquivalenceRelation< Arity >::size().

◆ isEndVal

template<typename TupleType >

bool souffle::EquivalenceRelation< TupleType >::iterator::isEndVal = false

private

Definition at line 456 of file EquivalenceRelation.h.

Referenced by souffle::EquivalenceRelation< TupleType >::iterator::iterator(), souffle::EquivalenceRelation< TupleType >::iterator::operator==(), souffle::EquivalenceRelation< TupleType >::iterator::setPosterior(), and souffle::EquivalenceRelation< Arity >::size().

◆ ityp

template<typename TupleType >

IterType souffle::EquivalenceRelation< TupleType >::iterator::ityp

private

Definition at line 460 of file EquivalenceRelation.h.

Referenced by souffle::EquivalenceRelation< Arity >::size().

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

include/souffle/datastructure/EquivalenceRelation.h

Public Types

Public Member Functions

Private Types

Private Attributes

Detailed Description

template<typename TupleType> class souffle::EquivalenceRelation< TupleType >::iterator

Member Typedef Documentation

◆ difference_type

◆ iterator_category

◆ pointer

◆ reference

◆ value_type

Member Enumeration Documentation

◆ IterType

Constructor & Destructor Documentation

◆ iterator() [1/7]

◆ iterator() [2/7]

◆ iterator() [3/7]

◆ iterator() [4/7]

◆ iterator() [5/7]

◆ iterator() [6/7]

◆ iterator() [7/7]

Member Function Documentation

◆ operator!=()

◆ operator*()

◆ operator++()

◆ operator->()

◆ operator=()

◆ operator==()

◆ setAnterior()

◆ setPosterior()

◆ updateAnterior()

◆ updatePosterior()

Field Documentation

◆ br

◆ cAnteriorIndex

◆ cPair

◆ cPosteriorIndex

◆ djSetList

◆ djSetMapListEnd

◆ djSetMapListIt

◆ isEndVal

◆ ityp

template<typename TupleType>
class souffle::EquivalenceRelation< TupleType >::iterator