Milo  0.1
Milo:EquationManipulationProgram
Public Member Functions | Private Member Functions | Private Attributes | List of all members
NodeIterator Class Reference

#include <milo.h>

Inheritance diagram for NodeIterator:
Inheritance graph
[legend]
Collaboration diagram for NodeIterator:
Collaboration graph
[legend]

Public Member Functions

 NodeIterator (Node *node)
 
Overloaded Operators
Node *& operator* ()
 
Node *& operator-> ()
 
bool operator== (const NodeIterator &rhs)
 
bool operator!= (const NodeIterator &rhs)
 
NodeIterator & operator++ ()
 
NodeIterator operator++ (int)
 
NodeIterator & operator-- ()
 
NodeIterator operator-- (int)
 

Private Member Functions

void next ()
 Advance this iterator next node.
 
void prev ()
 Iterator goes back previous node.
 

Private Attributes

Node * m_node
 Current node pointed to be iterator.
 

Detailed Description

Iterate over every node in an equation foward and backward. The precedence goes from deepest left most node to deepest right mode node.

Constructor & Destructor Documentation

NodeIterator::NodeIterator ( Node *  node)
inline

Constructor for NodeIterator class. Initialize the current node this iterator points to.

Parameters
nodeNew current node.

Member Function Documentation

bool NodeIterator::operator!= ( const NodeIterator &  rhs)
inline

Overloaded not equal operator.

Parameters
rhsNode to be compared.
Returns
True if node is not equal to rhs node.
Node*& NodeIterator::operator* ( )
inline

Overloaded dereference operator.

Returns
Current node.
NodeIterator& NodeIterator::operator++ ( )
inline

Overloaded postfix increment operator.

Returns
NodeIterator object pointing to next factor.
NodeIterator NodeIterator::operator++ ( int  )
inline

Overloaded prefix increment operator. This NodeIterator object will be decremented. Return an object with old iterator value.

Returns
Copy of NodeIterator pointing to old iterator value.
NodeIterator& NodeIterator::operator-- ( )
inline

Overloaded postfix decrement operator.

Returns
NodeIterator object pointing to previous factor.
NodeIterator NodeIterator::operator-- ( int  )
inline

Overloaded prefix decrement operator. This NodeIterator object will be decremented. Return an object with old iterator value.

Returns
Copy of NodeIterator pointing to old iterator value.
Node*& NodeIterator::operator-> ( )
inline

Overloaded member function operator. Returns pointer to current node to access member functions.

Returns
Current node member functions.
bool NodeIterator::operator== ( const NodeIterator &  rhs)
inline

Overloaded equal operator.

Parameters
rhsNode to be compared.
Returns
True if node is equal to rhs node.

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