Iterator type for souffle::SparseArray. More...

#include <Brie.h>

Collaboration diagram for souffle::detail::brie::SparseArrayIter< SparseArray >:

Public Types
using	array_value_type = typename SparseArray::value_type

using	index_type = typename SparseArray::index_type

using	Node = typename SparseArray::Node

using	value_type = std::pair< index_type, array_value_type >

Public Member Functions
bool	isEnd () const

bool	operator!= (const SparseArrayIter &other) const

const value_type &	operator* () const

SparseArrayIter &	operator++ ()

SparseArrayIter	operator++ (int)

const value_type *	operator-> () const

SparseArrayIter &	operator= (const SparseArrayIter &)=default

bool	operator== (const SparseArrayIter &other) const

void	print (std::ostream &out) const

	SparseArrayIter ()=default

	SparseArrayIter (const Node *first, index_type firstOffset)

	SparseArrayIter (const Node *node, value_type value)

	SparseArrayIter (const SparseArrayIter &)=default

Private Attributes
const Node *	node {}

value_type	value

Friends
std::ostream &	operator<< (std::ostream &out, const SparseArrayIter &iter)

Detailed Description

template<typename SparseArray>
struct souffle::detail::brie::SparseArrayIter< SparseArray >

Iterator type for souffle::SparseArray.

Definition at line 155 of file Brie.h.

Member Typedef Documentation

◆ array_value_type

template<typename SparseArray >

using souffle::detail::brie::SparseArrayIter< SparseArray >::array_value_type = typename SparseArray::value_type

Definition at line 158 of file Brie.h.

◆ index_type

template<typename SparseArray >

using souffle::detail::brie::SparseArrayIter< SparseArray >::index_type = typename SparseArray::index_type

Definition at line 157 of file Brie.h.

◆ Node

template<typename SparseArray >

using souffle::detail::brie::SparseArrayIter< SparseArray >::Node = typename SparseArray::Node

Definition at line 156 of file Brie.h.

◆ value_type

template<typename SparseArray >

using souffle::detail::brie::SparseArrayIter< SparseArray >::value_type = std::pair<index_type, array_value_type>

Definition at line 160 of file Brie.h.

Constructor & Destructor Documentation

◆ SparseArrayIter() [1/4]

template<typename SparseArray >

souffle::detail::brie::SparseArrayIter< SparseArray >::SparseArrayIter ( )

default

◆ SparseArrayIter() [2/4]

template<typename SparseArray >

souffle::detail::brie::SparseArrayIter< SparseArray >::SparseArrayIter ( const SparseArrayIter< SparseArray > & )

default

◆ SparseArrayIter() [3/4]

template<typename SparseArray >

souffle::detail::brie::SparseArrayIter< SparseArray >::SparseArrayIter	(	const Node *	node,
		value_type	value
	)

inline

Definition at line 166 of file Brie.h.

172 {

◆ SparseArrayIter() [4/4]

template<typename SparseArray >

souffle::detail::brie::SparseArrayIter< SparseArray >::SparseArrayIter	(	const Node *	first,
		index_type	firstOffset
	)

inline

Definition at line 168 of file Brie.h.

                                                         {
         return !(*this == other);
     }
  
     // the deref operator as required by the iterator concept
     const value_type& operator*() const {
         return value;

Member Function Documentation

◆ isEnd()

template<typename SparseArray >

bool souffle::detail::brie::SparseArrayIter< SparseArray >::isEnd ( ) const

inline

Definition at line 283 of file Brie.h.

        :
     // a pointer to the leaf node currently processed or null (end)
     const Node* node{};

◆ operator!=()

template<typename SparseArray >

bool souffle::detail::brie::SparseArrayIter< SparseArray >::operator!= ( const SparseArrayIter< SparseArray > & other ) const

inline

Definition at line 188 of file Brie.h.

193 {

◆ operator*()

template<typename SparseArray >

const value_type& souffle::detail::brie::SparseArrayIter< SparseArray >::operator* ( ) const

inline

Definition at line 193 of file Brie.h.

            {
             x++;
         } while (x < SparseArray::NUM_CELLS && node->cell[x].value == array_value_type());

◆ operator++() [1/2]

template<typename SparseArray >

SparseArrayIter& souffle::detail::brie::SparseArrayIter< SparseArray >::operator++ ( )

inline

Definition at line 203 of file Brie.h.

                                   {
             // search for next child
             while (x < SparseArray::NUM_CELLS) {
                 if (node->cell[x].ptr != nullptr) {
                     break;
                 }
                 x++;
             }
  
             // pick next step
             if (x < SparseArray::NUM_CELLS) {
                 // going down
                 node = node->cell[x].ptr;
                 value.first &= SparseArray::getLevelMask(level + 1);
                 value.first |= x << (SparseArray::BIT_PER_STEP * level);
                 level--;
                 x = 0;
             } else {
                 // going up
                 node = node->parent;
                 level++;
  
                 // get current index on this level
                 x = SparseArray::getIndex(brie_element_type(value.first), level);
                 x++;  // go one step further
             }
         }
  
         // check whether it is the end of range
         if (node == nullptr) {
             return *this;
         }
  
         // search the first value in this node
         x = 0;
         while (node->cell[x].value == array_value_type()) {
             x++;
         }
  
         // update value
         value.first |= x;
         value.second = node->cell[x].value;
  
         // done
         return *this;
     }
  
     SparseArrayIter operator++(int) {
         auto cpy = *this;
         ++(*this);
         return cpy;
     }
  
     // True if this iterator is passed the last element.
     bool isEnd() const {
         return node == nullptr;
     }
  
     // enables this iterator core to be printed (for debugging)
     void print(std::ostream& out) const {
         // `StreamUtil.h` defines an overload for `pair`, but we can't rely on it b/c
         // it's disabled if `__EMBEDDED__` is defined.

◆ operator++() [2/2]

template<typename SparseArray >

SparseArrayIter souffle::detail::brie::SparseArrayIter< SparseArray >::operator++ ( int )

inline

Definition at line 276 of file Brie.h.

                                                                                 {
         iter.print(out);
         return out;

◆ operator->()

template<typename SparseArray >

const value_type* souffle::detail::brie::SparseArrayIter< SparseArray >::operator-> ( ) const

inline

Definition at line 198 of file Brie.h.

                                       {
             // update value and be done
             value.first = (value.first & ~SparseArray::INDEX_MASK) | x;

References souffle::detail::brie::SparseArrayIter< SparseArray >::node, and souffle::detail::brie::SparseArrayIter< SparseArray >::value.

◆ operator=()

template<typename SparseArray >

SparseArrayIter& souffle::detail::brie::SparseArrayIter< SparseArray >::operator= ( const SparseArrayIter< SparseArray > & )

default

◆ operator==()

template<typename SparseArray >

bool souffle::detail::brie::SparseArrayIter< SparseArray >::operator== ( const SparseArrayIter< SparseArray > & other ) const

inline

Definition at line 181 of file Brie.h.

                                          {
         return &value;
     }
  

References souffle::detail::brie::SparseArrayIter< SparseArray >::value.

◆ print()

template<typename SparseArray >

void souffle::detail::brie::SparseArrayIter< SparseArray >::print ( std::ostream & out ) const

inline

Definition at line 288 of file Brie.h.

Friends And Related Function Documentation

◆ operator<<

template<typename SparseArray >

std::ostream& operator<<	(	std::ostream &	out,
		const SparseArrayIter< SparseArray > &	iter
	)

friend

Definition at line 294 of file Brie.h.

323 {

Field Documentation

◆ node

template<typename SparseArray >

const Node* souffle::detail::brie::SparseArrayIter< SparseArray >::node {}

private

Definition at line 301 of file Brie.h.

Referenced by souffle::detail::brie::SparseArrayIter< SparseArray >::operator->().

◆ value

template<typename SparseArray >

value_type souffle::detail::brie::SparseArrayIter< SparseArray >::value

private

Definition at line 304 of file Brie.h.

Referenced by souffle::detail::brie::SparseArrayIter< SparseArray >::operator->(), and souffle::detail::brie::SparseArrayIter< SparseArray >::operator==().

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

include/souffle/datastructure/Brie.h

Public Types

Public Member Functions

Private Attributes

Friends

Detailed Description

template<typename SparseArray> struct souffle::detail::brie::SparseArrayIter< SparseArray >

Member Typedef Documentation

◆ array_value_type

◆ index_type

◆ Node

◆ value_type

Constructor & Destructor Documentation

◆ SparseArrayIter() [1/4]

◆ SparseArrayIter() [2/4]

◆ SparseArrayIter() [3/4]

◆ SparseArrayIter() [4/4]

Member Function Documentation

◆ isEnd()

◆ operator!=()

◆ operator*()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator->()

◆ operator=()

◆ operator==()

◆ print()

Friends And Related Function Documentation

◆ operator<<

Field Documentation

◆ node

◆ value

template<typename SparseArray>
struct souffle::detail::brie::SparseArrayIter< SparseArray >