fastjet::SearchTree< T >::circulator Class Reference

#include <SearchTree.hh>

Collaboration diagram for fastjet::SearchTree< T >::circulator:

List of all members.

Public Member Functions
	circulator ()
	circulator (Node *node)
const T *	operator-> () const
T *	operator-> ()
const T &	operator* () const
T &	operator* ()
circulator &	operator++ ()
	prefix increment (structure copied from stl_bvector.h)
circulator	operator++ (int)
	postfix increment ["int" argument tells compiler it's postfix] (structure copied from stl_bvector.h)
circulator &	operator-- ()
	prefix decrement (structure copied from stl_bvector.h)
circulator	operator-- (int)
	postfix decrement ["int" argument tells compiler it's postfix] (structure copied from stl_bvector.h)
circulator	next () const
	return a circulator referring to the next node
circulator	previous () const
	return a circulator referring to the previous node
bool	operator!= (const circulator &other) const
bool	operator== (const circulator &other) const
Private Attributes
Node *	_node
Friends
class	SearchTree< T >

---

Detailed Description

template<class T>
class fastjet::SearchTree< T >::circulator

Definition at line 173 of file SearchTree.hh.

---

Constructor & Destructor Documentation

template<class T >

fastjet::SearchTree< T >::circulator::circulator

(

)

[inline]

Definition at line 181 of file SearchTree.hh.

: _node(NULL) {}

template<class T >

fastjet::SearchTree< T >::circulator::circulator

(

Node *

node

)

[inline]

Definition at line 183 of file SearchTree.hh.

: _node(node) {}

---

Member Function Documentation

template<class T >

circulator fastjet::SearchTree< T >::circulator::next

(

)

const [inline]

return a circulator referring to the next node

Definition at line 215 of file SearchTree.hh.

Referenced by fastjet::ClosestPair2D::_remove_from_search_tree().

                          {
    return circulator(_node->successor);}

template<class T >

bool fastjet::SearchTree< T >::circulator::operator!=

(

const circulator &

other

)

const [inline]

Definition at line 222 of file SearchTree.hh.

References fastjet::SearchTree< T >::circulator::_node.

{return other._node != _node;}

template<class T >

T& fastjet::SearchTree< T >::circulator::operator*

(

)

[inline]

Definition at line 188 of file SearchTree.hh.

{return _node->value;}

template<class T >

const T& fastjet::SearchTree< T >::circulator::operator*

(

)

const [inline]

Definition at line 187 of file SearchTree.hh.

{return _node->value;}

template<class T >

circulator& fastjet::SearchTree< T >::circulator::operator++

(

)

[inline]

prefix increment (structure copied from stl_bvector.h)

Definition at line 191 of file SearchTree.hh.

                            {
    _node = _node->successor; 
    return *this;}

template<class T >

circulator fastjet::SearchTree< T >::circulator::operator++

(

int

)

[inline]

postfix increment ["int" argument tells compiler it's postfix] (structure copied from stl_bvector.h)

Definition at line 197 of file SearchTree.hh.

                             {
    circulator tmp = *this;
    _node = _node->successor; 
    return tmp;}

template<class T >

circulator fastjet::SearchTree< T >::circulator::operator--

(

int

)

[inline]

postfix decrement ["int" argument tells compiler it's postfix] (structure copied from stl_bvector.h)

Definition at line 209 of file SearchTree.hh.

                             {
    circulator tmp = *this;
    _node = _node->predecessor; 
    return tmp;}

template<class T >

circulator& fastjet::SearchTree< T >::circulator::operator--

(

)

[inline]

prefix decrement (structure copied from stl_bvector.h)

Definition at line 203 of file SearchTree.hh.

                            {
    _node = _node->predecessor; 
    return *this;}

template<class T >

T* fastjet::SearchTree< T >::circulator::operator->

(

)

[inline]

Definition at line 186 of file SearchTree.hh.

{return &(_node->value);}

template<class T >

const T* fastjet::SearchTree< T >::circulator::operator->

(

)

const [inline]

Definition at line 185 of file SearchTree.hh.

{return &(_node->value);}

template<class T >

bool fastjet::SearchTree< T >::circulator::operator==

(

const circulator &

other

)

const [inline]

Definition at line 223 of file SearchTree.hh.

References fastjet::SearchTree< T >::circulator::_node.

{return other._node == _node;}

template<class T >

circulator fastjet::SearchTree< T >::circulator::previous

(

)

const [inline]

return a circulator referring to the previous node

Definition at line 219 of file SearchTree.hh.

                              {
    return circulator(_node->predecessor);}

---

Friends And Related Function Documentation

template<class T >

friend class SearchTree< T > [friend]

Definition at line 179 of file SearchTree.hh.

---

Member Data Documentation

template<class T >

Node* fastjet::SearchTree< T >::circulator::_node [private]

Definition at line 226 of file SearchTree.hh.

Referenced by fastjet::SearchTree< T >::circulator::operator!=(), fastjet::SearchTree< T >::circulator::operator==(), and fastjet::SearchTree< T >::remove().

---

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

• include/fastjet/internal/SearchTree.hh