folly::padded::Iterator< Iter > Class Template Reference

#include <Padded.h>

Inheritance diagram for folly::padded::Iterator< Iter >:

Public Types
typedef std::iterator_traits< Iter >::value_type	Node

Public Member Functions
	Iterator ()
	Iterator (Iter base)
const Node &	node () const
size_t	pos () const

Private Types
typedef detail::IteratorBase< Iter >::type	Super

Private Member Functions
Super::reference	dereference () const
bool	equal (const Iterator &other) const
void	advance (typename Super::difference_type n)
void	increment ()
void	decrement ()
Super::difference_type	distance_to (const Iterator &other) const

Private Attributes
ssize_t	pos_

Friends
class	boost::iterator_core_access

Detailed Description

template<class Iter>
class folly::padded::Iterator< Iter >

Wrapper around iterators to Node to return iterators to the underlying node elements.

Definition at line 155 of file Padded.h.

Member Typedef Documentation

template<class Iter >

typedef std::iterator_traits<Iter>::value_type folly::padded::Iterator< Iter >::Node

Definition at line 245 of file Padded.h.

template<class Iter >

typedef detail::IteratorBase<Iter>::type folly::padded::Iterator< Iter >::Super

private

Definition at line 242 of file Padded.h.

Constructor & Destructor Documentation

template<class Iter >

folly::padded::Iterator< Iter >::Iterator ( )

inline

Definition at line 247 of file Padded.h.

: pos_(0) {}

template<class Iter >

folly::padded::Iterator< Iter >::Iterator ( Iter  base )

inlineexplicit

Definition at line 249 of file Padded.h.

: Super(base), pos_(0) {}

Member Function Documentation

template<class Iter >

void folly::padded::Iterator< Iter >::advance ( typename Super::difference_type  n )

inlineprivate

Definition at line 269 of file Padded.h.

                                                {
    constexpr ssize_t elementCount = Node::kElementCount; // signed!
    ssize_t newPos = pos_ + n;
    if (newPos >= 0 && newPos < elementCount) {
      pos_ = newPos;
      return;
    }
    ssize_t nblocks = newPos / elementCount;
    newPos %= elementCount;
    if (newPos < 0) {
      --nblocks; // negative
      newPos += elementCount;
    }
    this->base_reference() += nblocks;
    pos_ = newPos;
  }

template<class Iter >

void folly::padded::Iterator< Iter >::decrement ( )

inlineprivate

Definition at line 293 of file Padded.h.

                   {
    if (--pos_ == -1) {
      --this->base_reference();
      pos_ = Node::kElementCount - 1;
    }
  }

template<class Iter >

Super::reference folly::padded::Iterator< Iter >::dereference ( ) const

inlineprivate

Definition at line 260 of file Padded.h.

                                              {
    return (*this->base_reference()).data()[pos_];
  }

template<class Iter >

Super::difference_type folly::padded::Iterator< Iter >::distance_to ( const Iterator< Iter > &  other ) const

inlineprivate

Definition at line 300 of file Padded.h.

References folly::padded::Iterator< Iter >::pos_.

                                                                         {
    constexpr ssize_t elementCount = Node::kElementCount; // signed!
    ssize_t nblocks =
        std::distance(this->base_reference(), other.base_reference());
    return nblocks * elementCount + (other.pos_ - pos_);
  }

template<class Iter >

bool folly::padded::Iterator< Iter >::equal ( const Iterator< Iter > &  other ) const

inlineprivate

Definition at line 264 of file Padded.h.

References folly::padded::Iterator< Iter >::pos_.

                                          {
    return (
        this->base_reference() == other.base_reference() && pos_ == other.pos_);
  }

template<class Iter >

void folly::padded::Iterator< Iter >::increment ( )

inlineprivate

Definition at line 286 of file Padded.h.

                   {
    if (++pos_ == Node::kElementCount) {
      ++this->base_reference();
      pos_ = 0;
    }
  }

template<class Iter >

const Node& folly::padded::Iterator< Iter >::node ( ) const

inline

Definition at line 252 of file Padded.h.

                           {
    return *this->base_reference();
  }

template<class Iter >

size_t folly::padded::Iterator< Iter >::pos ( ) const

inline

Definition at line 255 of file Padded.h.

                     {
    return pos_;
  }

Friends And Related Function Documentation

template<class Iter >

friend class boost::iterator_core_access

friend

Definition at line 307 of file Padded.h.

Member Data Documentation

template<class Iter >

ssize_t folly::padded::Iterator< Iter >::pos_

private

Definition at line 308 of file Padded.h.

Referenced by folly::padded::Iterator< Iter >::distance_to(), and folly::padded::Iterator< Iter >::equal().

---

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

• proxygen/folly/folly/Padded.h