Parma_Polyhedra_Library::CO_Tree::const_iterator Class Reference

A const iterator on the tree elements, ordered by key. More...

#include <CO_Tree_defs.hh>

Public Types
typedef std::bidirectional_iterator_tag	iterator_category
typedef const data_type	value_type
typedef std::ptrdiff_t	difference_type
typedef value_type *	pointer
typedef data_type_const_reference	reference

Public Member Functions
	const_iterator ()
	Constructs an invalid const_iterator. More...
	const_iterator (const CO_Tree &tree)
	Constructs an iterator pointing to the first element of the tree. More...
	const_iterator (const CO_Tree &tree, dimension_type i)
	Constructs a const_iterator pointing to the i-th node of the tree. More...
	const_iterator (const const_iterator &itr)
	The copy constructor. More...
	const_iterator (const iterator &itr)
	Converts an iterator into a const_iterator. More...
void	m_swap (const_iterator &itr)
	Swaps itr with *this. More...
const_iterator &	operator= (const const_iterator &itr)
	Assigns itr to *this . More...
const_iterator &	operator= (const iterator &itr)
	Assigns itr to *this . More...
const_iterator &	operator++ ()
	Navigates to the next element. More...
const_iterator &	operator-- ()
	Navigates to the previous element. More...
const_iterator	operator++ (int)
	Navigates to the next element. More...
const_iterator	operator-- (int)
	Navigates to the previous element. More...
data_type_const_reference	operator* () const
	Returns the current element. More...
dimension_type	index () const
	Returns the index of the element pointed to by *this. More...
bool	operator== (const const_iterator &x) const
	Compares *this with x . More...
bool	operator!= (const const_iterator &x) const
	Compares *this with x . More...

Private Member Functions
bool	OK () const
	Checks the internal invariants, in debug mode only. More...

Private Attributes
const dimension_type *	current_index
	A pointer to the corresponding element of the tree's indexes[] array. More...
const data_type *	current_data
	A pointer to the corresponding element of the tree's data[] array. More...

Friends
dimension_type	CO_Tree::dfs_index (const_iterator itr) const

Related Functions
(Note that these are not member functions.)
void	swap (CO_Tree::const_iterator &x, CO_Tree::const_iterator &y)
	Swaps x with y. More...

Detailed Description

A const iterator on the tree elements, ordered by key.

Iterator increment and decrement operations are time. These iterators are invalidated by operations that add or remove elements from the tree.

Definition at line 157 of file CO_Tree_defs.hh.

Member Typedef Documentation

typedef std::ptrdiff_t Parma_Polyhedra_Library::CO_Tree::const_iterator::difference_type

Definition at line 163 of file CO_Tree_defs.hh.

typedef std::bidirectional_iterator_tag Parma_Polyhedra_Library::CO_Tree::const_iterator::iterator_category

Definition at line 161 of file CO_Tree_defs.hh.

typedef value_type* Parma_Polyhedra_Library::CO_Tree::const_iterator::pointer

Definition at line 164 of file CO_Tree_defs.hh.

typedef data_type_const_reference Parma_Polyhedra_Library::CO_Tree::const_iterator::reference

Definition at line 165 of file CO_Tree_defs.hh.

typedef const data_type Parma_Polyhedra_Library::CO_Tree::const_iterator::value_type

Definition at line 162 of file CO_Tree_defs.hh.

Constructor & Destructor Documentation

Parma_Polyhedra_Library::CO_Tree::const_iterator::const_iterator ( )

inlineexplicit

Constructs an invalid const_iterator.

This constructor takes time.

Definition at line 359 of file CO_Tree_inlines.hh.

References OK().

  : current_index(0), current_data(0) {
#if PPL_CO_TREE_EXTRA_DEBUG
  tree = 0;
#endif
  PPL_ASSERT(OK());
}

Parma_Polyhedra_Library::CO_Tree::const_iterator::const_iterator ( const CO_Tree &  tree )

inlineexplicit

Constructs an iterator pointing to the first element of the tree.

Parameters

tree	The tree that the new iterator will point to.

This constructor takes time.

Definition at line 368 of file CO_Tree_inlines.hh.

References current_data, current_index, Parma_Polyhedra_Library::CO_Tree::empty(), OK(), and Parma_Polyhedra_Library::CO_Tree::unused_index.

  : current_index(&(tree1.indexes[1])), current_data(&(tree1.data[1])) {
#if PPL_CO_TREE_EXTRA_DEBUG
  tree = &tree1;
#endif
  if (!tree1.empty()) {
    while (*current_index == unused_index) {
      ++current_index;
      ++current_data;
    }
  }
  PPL_ASSERT(OK());
}

Parma_Polyhedra_Library::CO_Tree::const_iterator::const_iterator ( const CO_Tree &  tree, dimension_type  i  )

inline

Constructs a const_iterator pointing to the i-th node of the tree.

Parameters

tree	The tree that the new iterator will point to.
i	The index of the element in tree to which the iterator will point to.

The i-th node must be a node with a value or end().

This constructor takes time.

Definition at line 383 of file CO_Tree_inlines.hh.

References Parma_Polyhedra_Library::CO_Tree::empty(), Parma_Polyhedra_Library::CO_Tree::indexes, OK(), Parma_Polyhedra_Library::CO_Tree::reserved_size, and Parma_Polyhedra_Library::CO_Tree::unused_index.

  : current_index(&(tree1.indexes[i])), current_data(&(tree1.data[i])) {
#if PPL_CO_TREE_EXTRA_DEBUG
  tree = &tree1;
#endif
  PPL_ASSERT(i != 0);
  PPL_ASSERT(i <= tree1.reserved_size + 1);
  PPL_ASSERT(tree1.empty() || tree1.indexes[i] != unused_index);
  PPL_ASSERT(OK());
}

Parma_Polyhedra_Library::CO_Tree::const_iterator::const_iterator ( const const_iterator &  itr )

inline

The copy constructor.

Parameters

itr	The iterator that will be copied.

This constructor takes time.

Definition at line 396 of file CO_Tree_inlines.hh.

References Parma_Polyhedra_Library::CO_Tree::OK().

                                                                {
  (*this) = itr2;
  PPL_ASSERT(OK());
}

Parma_Polyhedra_Library::CO_Tree::const_iterator::const_iterator ( const iterator &  itr )

inline

Converts an iterator into a const_iterator.

Parameters

itr	The iterator that will be converted into a const_iterator.

This constructor takes time.

Definition at line 402 of file CO_Tree_inlines.hh.

References Parma_Polyhedra_Library::CO_Tree::OK().

                                                          {
  (*this) = itr2;
  PPL_ASSERT(OK());
}

Member Function Documentation

dimension_type Parma_Polyhedra_Library::CO_Tree::const_iterator::index ( ) const

inline

Returns the index of the element pointed to by *this.

Returns

the index of the element pointed to by *this.

Definition at line 498 of file CO_Tree_inlines.hh.

References Parma_Polyhedra_Library::CO_Tree::OK().

Referenced by Parma_Polyhedra_Library::PIP_Tree_Node::add_constraint(), Parma_Polyhedra_Library::Linear_Expression_Impl< Row >::all_zeroes(), Parma_Polyhedra_Library::Sparse_Row::combine(), Parma_Polyhedra_Library::Sparse_Row::combine_needs_first(), Parma_Polyhedra_Library::MIP_Problem::erase_artificials(), Parma_Polyhedra_Library::Sparse_Row::find(), Parma_Polyhedra_Library::Linear_Expression_Impl< Row >::first_nonzero(), Parma_Polyhedra_Library::PIP_Solution_Node::generate_cut(), Parma_Polyhedra_Library::Linear_Expression_Impl< Row >::has_a_free_dimension_helper(), Parma_Polyhedra_Library::Linear_Expression_Impl< Row >::have_a_common_variable(), Parma_Polyhedra_Library::Dense_Row::init(), Parma_Polyhedra_Library::PIP_Solution_Node::Tableau::is_better_pivot(), Parma_Polyhedra_Library::Linear_Expression_Impl< Row >::last_nonzero(), Parma_Polyhedra_Library::Sparse_Row::linear_combine(), Parma_Polyhedra_Library::Sparse_Row::lower_bound(), Parma_Polyhedra_Library::MIP_Problem::OK(), Parma_Polyhedra_Library::Sparse_Row::OK(), Parma_Polyhedra_Library::Dense_Row::operator=(), Parma_Polyhedra_Library::Sparse_Row::operator==(), Parma_Polyhedra_Library::operator==(), Parma_Polyhedra_Library::MIP_Problem::process_pending_constraints(), Parma_Polyhedra_Library::MIP_Problem::steepest_edge_exact_entering_index(), Parma_Polyhedra_Library::MIP_Problem::steepest_edge_float_entering_index(), Parma_Polyhedra_Library::CO_Tree::structure_OK(), Parma_Polyhedra_Library::MIP_Problem::textbook_entering_index(), and Parma_Polyhedra_Library::PIP_Solution_Node::update_solution().

                                   {
  PPL_ASSERT(current_index != 0);
  PPL_ASSERT(current_data != 0);
  PPL_ASSERT(OK());
#if PPL_CO_TREE_EXTRA_DEBUG
  PPL_ASSERT(current_index != &(tree->indexes[tree->reserved_size + 1]));
#endif
  return *current_index;
}

void Parma_Polyhedra_Library::CO_Tree::const_iterator::m_swap ( const_iterator &  itr )

inline

Swaps itr with *this.

Parameters

itr	The iterator that will be swapped with *this.

This method takes time.

Definition at line 408 of file CO_Tree_inlines.hh.

References current_data, current_index, OK(), Parma_Polyhedra_Library::CO_Tree::OK(), Parma_Polyhedra_Library::swap(), and Parma_Polyhedra_Library::CO_Tree::swap().

Referenced by Parma_Polyhedra_Library::swap().

                                                 {
  using std::swap;
  swap(current_data, itr.current_data);
  swap(current_index, itr.current_index);
#if PPL_CO_TREE_EXTRA_DEBUG
  swap(tree, itr.tree);
#endif
  PPL_ASSERT(OK());
  PPL_ASSERT(itr.OK());
}

bool Parma_Polyhedra_Library::CO_Tree::const_iterator::OK ( ) const

private

Checks the internal invariants, in debug mode only.

Definition at line 1317 of file CO_Tree.cc.

Referenced by const_iterator(), and m_swap().

                                   {
#if PPL_CO_TREE_EXTRA_DEBUG
  if (tree == 0) {
    if (current_index != 0) {
      return false;
    }
    if (current_data != 0) {
      return false;
    }
  }
  else
    if (tree->reserved_size == 0) {
      if (current_index != 1 + static_cast<dimension_type*>(0)
          || current_data != 1 + static_cast<data_type*>(0)) {
        return false;
      }
    }
    else {
      if (current_index <= &(tree->indexes[0])) {
        return false;
      }
      if (current_index > &(tree->indexes[tree->reserved_size + 1])) {
        return false;
      }
      if (current_data <= &(tree->data[0])) {
        return false;
      }
      if (current_data > &(tree->data[tree->reserved_size + 1])) {
        return false;
      }
      if (*current_index == unused_index) {
        return false;
      }
      if (current_index - tree->indexes != current_data - tree->data) {
        return false;
      }
    }
#endif
  return true;
}

bool Parma_Polyhedra_Library::CO_Tree::const_iterator::operator!= ( const const_iterator &  x ) const

inline

Compares *this with x .

Parameters

x	The iterator that will be compared with *this.

Definition at line 517 of file CO_Tree_inlines.hh.

                                                               {
  return !(*this == x);
}

Coefficient_traits::const_reference Parma_Polyhedra_Library::CO_Tree::const_iterator::operator* ( ) const

inline

Returns the current element.

Definition at line 487 of file CO_Tree_inlines.hh.

References Parma_Polyhedra_Library::CO_Tree::OK().

                                       {
  PPL_ASSERT(current_index != 0);
  PPL_ASSERT(current_data != 0);
  PPL_ASSERT(OK());
#if PPL_CO_TREE_EXTRA_DEBUG
  PPL_ASSERT(current_index != &(tree->indexes[tree->reserved_size + 1]));
#endif
  return *current_data;
}

CO_Tree::const_iterator & Parma_Polyhedra_Library::CO_Tree::const_iterator::operator++ ( )

inline

Navigates to the next element.

This method takes time.

Definition at line 442 of file CO_Tree_inlines.hh.

References Parma_Polyhedra_Library::CO_Tree::OK(), and Parma_Polyhedra_Library::CO_Tree::unused_index.

                                  {
  PPL_ASSERT(current_index != 0);
  PPL_ASSERT(current_data != 0);
#if PPL_CO_TREE_EXTRA_DEBUG
  PPL_ASSERT(current_index != &(tree->indexes[tree->reserved_size + 1]));
#endif
  ++current_index;
  ++current_data;
  while (*current_index == unused_index) {
    ++current_index;
    ++current_data;
  }
  PPL_ASSERT(OK());
  return *this;
}

CO_Tree::const_iterator Parma_Polyhedra_Library::CO_Tree::const_iterator::operator++ ( int  )

inline

Navigates to the next element.

This method takes time.

Definition at line 473 of file CO_Tree_inlines.hh.

                                     {
  const_iterator itr(*this);
  ++(*this);
  return itr;
}

CO_Tree::const_iterator & Parma_Polyhedra_Library::CO_Tree::const_iterator::operator-- ( )

inline

Navigates to the previous element.

This method takes time.

Definition at line 459 of file CO_Tree_inlines.hh.

References Parma_Polyhedra_Library::CO_Tree::OK(), and Parma_Polyhedra_Library::CO_Tree::unused_index.

                                  {
  PPL_ASSERT(current_index != 0);
  PPL_ASSERT(current_data != 0);
  --current_index;
  --current_data;
  while (*current_index == unused_index) {
    --current_index;
    --current_data;
  }
  PPL_ASSERT(OK());
  return *this;
}

CO_Tree::const_iterator Parma_Polyhedra_Library::CO_Tree::const_iterator::operator-- ( int  )

inline

Navigates to the previous element.

This method takes time.

Definition at line 480 of file CO_Tree_inlines.hh.

                                     {
  const_iterator itr(*this);
  --(*this);
  return itr;
}

CO_Tree::const_iterator & Parma_Polyhedra_Library::CO_Tree::const_iterator::operator= ( const const_iterator &  itr )

inline

Assigns itr to *this .

Parameters

itr	The iterator that will be assigned into *this.

This method takes time.

Definition at line 420 of file CO_Tree_inlines.hh.

References current_data, current_index, and Parma_Polyhedra_Library::CO_Tree::OK().

                                                           {
  current_index = itr2.current_index;
  current_data = itr2.current_data;
#if PPL_CO_TREE_EXTRA_DEBUG
  tree = itr2.tree;
#endif
  PPL_ASSERT(OK());
  return *this;
}

CO_Tree::const_iterator & Parma_Polyhedra_Library::CO_Tree::const_iterator::operator= ( const iterator &  itr )

inline

Assigns itr to *this .

Parameters

itr	The iterator that will be assigned into *this.

This method takes time.

Definition at line 431 of file CO_Tree_inlines.hh.

References Parma_Polyhedra_Library::CO_Tree::iterator::current_data, Parma_Polyhedra_Library::CO_Tree::iterator::current_index, and Parma_Polyhedra_Library::CO_Tree::OK().

                                                     {
  current_index = itr2.current_index;
  current_data = itr2.current_data;
#if PPL_CO_TREE_EXTRA_DEBUG
  tree = itr2.tree;
#endif
  PPL_ASSERT(OK());
  return *this;
}

bool Parma_Polyhedra_Library::CO_Tree::const_iterator::operator== ( const const_iterator &  x ) const

inline

Compares *this with x .

Parameters

x	The iterator that will be compared with *this.

Definition at line 509 of file CO_Tree_inlines.hh.

References current_data, current_index, and Parma_Polyhedra_Library::CO_Tree::OK().

                                                               {
  PPL_ASSERT((current_index == x.current_index)
             == (current_data == x.current_data));
  PPL_ASSERT(OK());
  return (current_index == x.current_index);
}

Friends And Related Function Documentation

dimension_type CO_Tree::dfs_index ( const_iterator  itr ) const

friend

void swap ( CO_Tree::const_iterator &  x, CO_Tree::const_iterator &  y  )

related

Swaps x with y.

Definition at line 878 of file CO_Tree_inlines.hh.

                                                         {
  x.m_swap(y);
}

Member Data Documentation

const data_type* Parma_Polyhedra_Library::CO_Tree::const_iterator::current_data

private

A pointer to the corresponding element of the tree's data[] array.

Definition at line 297 of file CO_Tree_defs.hh.

Referenced by const_iterator(), m_swap(), operator=(), and operator==().

const dimension_type* Parma_Polyhedra_Library::CO_Tree::const_iterator::current_index

private

A pointer to the corresponding element of the tree's indexes[] array.

Definition at line 294 of file CO_Tree_defs.hh.

Referenced by const_iterator(), Parma_Polyhedra_Library::CO_Tree::dfs_index(), m_swap(), operator=(), and operator==().

---

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

• CO_Tree_defs.hh
• CO_Tree.cc
• CO_Tree_inlines.hh