Traversals::ImageTraversal::Iterator Class Reference

A forward iterator through an ImageTraversal. More...

#include <ImageTraversal.h>

Public Types
using	iterator_category = std::forward_iterator_tag
using	value_type = Point
using	difference_type = std::ptrdiff_t
using	pointer = Point *
using	reference = Point &

Public Member Functions
	Iterator ()
	Default iterator constructor. More...
Iterator &	operator++ ()
	Iterator increment operator. More...
Point	operator* ()
	Iterator accessor operator. More...
bool	operator!= (const Iterator &other)
	Iterator inequality operator. More...
size_t	size () const
	Iterator size function. More...
bool	empty () const
	Iterator empty function. More...

Detailed Description

A forward iterator through an ImageTraversal.

Constructor & Destructor Documentation

Iterator()

Traversals::ImageTraversal::Iterator::Iterator

(

)

Default iterator constructor.

Todo:

[Part 1]

Member Function Documentation

empty()

bool Traversals::ImageTraversal::Iterator::empty

(

)

const

Iterator empty function.

Returns

bool whether the iterator work queue is empty.

operator!=()

bool Traversals::ImageTraversal::Iterator::operator!=

(

const Iterator &

other

)

Iterator inequality operator.

Determines if two iterators are not equal.

Todo:

[Part 1]

operator*()

Point Traversals::ImageTraversal::Iterator::operator*

(

)

Iterator accessor operator.

Accesses the current Point in the ImageTraversal.

Todo:

[Part 1]

operator++()

ImageTraversal::Iterator & Traversals::ImageTraversal::Iterator::operator++

(

)

Iterator increment operator.

Advances the traversal of the image.

Todo:

[Part 1]

size()

size_t Traversals::ImageTraversal::Iterator::size

(

)

const

Iterator size function.

Returns

size_t the size of the iterator work queue.

---

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

• src/ImageTraversal.h
• src/ImageTraversal.cpp