Nsound::circular_iterator Class Reference

A circulator iterator for class Buffer. More...

#include <Nsound/CircularIterators.h>

Public Member Functions
	circular_iterator (FloatVector &v)
	circular_iterator (const circular_iterator &copy)
circular_iterator &	operator= (const circular_iterator &rhs)
void	reset ()
bool	operator== (const circular_iterator &rhs) const
bool	operator!= (const circular_iterator &rhs) const
circular_iterator &	operator++ ()
circular_iterator &	operator-- ()
circular_iterator	operator++ (int)
circular_iterator &	operator+= (int32 i)
circular_iterator &	operator-= (int32 i)
FloatVector::value_type &	operator* ()
float64	__float__ () const
std::string	__str__ () const

Private Attributes
FloatVector::const_iterator	end_
FloatVector::iterator	itor_
FloatVector *	data_

Detailed Description

A circulator iterator for class Buffer.

This iterator should behave like a normal std::vector::iterator, but when the iterator reaches the end of the vector, it will automatically wrap around back to the front.

Example:

// C++
Buffer b1("california.wav");
Buffer b2;
Buffer::circular_iterator ctor = b1.cbegin();
for(i = 0; i < 1e6; ++i) b2 << *ctor;

// Python, not currently supported.

Definition at line 63 of file CircularIterators.h.

Constructor & Destructor Documentation

Nsound::circular_iterator::circular_iterator ( FloatVector &  v )

inline

Definition at line 68 of file CircularIterators.h.

        :
        end_(v.end()),
        itor_(v.begin()),
        data_(&v)
    {}

Nsound::circular_iterator::circular_iterator ( const circular_iterator &  copy )

inline

Definition at line 75 of file CircularIterators.h.

        :
        end_(copy.end_),
        itor_(copy.itor_),
        data_(copy.data_)
    {}

Member Function Documentation

circular_iterator& Nsound::circular_iterator::operator= ( const circular_iterator &  rhs )

inline

Definition at line 82 of file CircularIterators.h.

References data_, end_, and itor_.

    {
        if(this == &rhs) return *this;

        end_ = rhs.end_;
        itor_ = rhs.itor_;
        data_ = rhs.data_;

        return *this;
    }

void Nsound::circular_iterator::reset ( )

inline

Definition at line 93 of file CircularIterators.h.

References data_, and itor_.

Referenced by Buffer_UnitTest().

{ itor_ = data_->begin(); }

bool Nsound::circular_iterator::operator== ( const circular_iterator &  rhs ) const

inline

Definition at line 95 of file CircularIterators.h.

References data_, and itor_.

    {
        return
            data_ == rhs.data_ &&
            itor_ == rhs.itor_;
    }

bool Nsound::circular_iterator::operator!= ( const circular_iterator &  rhs ) const

inline

Definition at line 102 of file CircularIterators.h.

References data_, and itor_.

    {
        return
            data_ != rhs.data_ ||
            itor_ != rhs.itor_;
    }

circular_iterator& Nsound::circular_iterator::operator++ ( )

inline

Definition at line 109 of file CircularIterators.h.

References data_, end_, and itor_.

Referenced by operator++().

    {
        ++itor_;

        if(itor_ >= end_) itor_ = data_->begin();

        return *this;
    }

circular_iterator& Nsound::circular_iterator::operator-- ( )

inline

Definition at line 118 of file CircularIterators.h.

References data_, and itor_.

    {
        if(itor_ == data_->begin()) itor_ = data_->end() - 1;
        else                      --itor_;

        return *this;
    }

circular_iterator Nsound::circular_iterator::operator++ ( int  )

inline

Definition at line 126 of file CircularIterators.h.

References operator++().

    {
        circular_iterator tmp(*this);
        operator++();
        return tmp;
    }

circular_iterator& Nsound::circular_iterator::operator+= ( int32  i )

inline

Definition at line 133 of file CircularIterators.h.

References data_, and itor_.

    {
        if(i < 0) return *this -= -i;
        auto pos = std::distance(data_->begin(), itor_);
        pos = (pos + i) % data_->size();
        itor_ = data_->begin() + pos;
        return *this;
    }

circular_iterator& Nsound::circular_iterator::operator-= ( int32  i )

inline

Definition at line 142 of file CircularIterators.h.

References data_, and itor_.

    {
        if(i < 0) return *this += -i;
        auto pos = std::distance(data_->begin(), itor_);
        pos -= (i % data_->size());
        if(pos < 0) pos += data_->size();
        itor_ = data_->begin() + pos;
        return *this;
    }

FloatVector::value_type& Nsound::circular_iterator::operator* ( )

inline

Definition at line 152 of file CircularIterators.h.

References itor_.

    {
        return *itor_;
    }

float64 Nsound::circular_iterator::__float__ ( ) const

inline

Definition at line 157 of file CircularIterators.h.

References itor_.

    {
        return *itor_;
    }

std::string Nsound::circular_iterator::__str__ ( ) const

inline

Definition at line 162 of file CircularIterators.h.

References data_, and itor_.

    {
        std::stringstream ss;

        ss
            << "Nsound::Buffer::circular_iterator(vector at 0x0"
            << std::hex
            << reinterpret_cast<uint64>(data_)
            << ", index = ";

        uint64 pos = itor_ - data_->begin();

        ss << std::dec << pos << ")";

        return ss.str();
    }

Member Data Documentation

FloatVector::const_iterator Nsound::circular_iterator::end_

private

Definition at line 181 of file CircularIterators.h.

Referenced by operator++(), and operator=().

FloatVector::iterator Nsound::circular_iterator::itor_

private

Definition at line 182 of file CircularIterators.h.

Referenced by __float__(), __str__(), operator!=(), operator*(), operator++(), operator+=(), operator--(), operator-=(), operator=(), operator==(), and reset().

FloatVector* Nsound::circular_iterator::data_

private

Definition at line 183 of file CircularIterators.h.

Referenced by __str__(), operator!=(), operator++(), operator+=(), operator--(), operator-=(), operator=(), operator==(), and reset().

---

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

• Nsound/CircularIterators.h