Parma_Polyhedra_Library::Generator_System_const_iterator Class Reference

An iterator over a system of generators. More...

#include <Generator_System_defs.hh>

Inheritance diagram for Parma_Polyhedra_Library::Generator_System_const_iterator:

Collaboration diagram for Parma_Polyhedra_Library::Generator_System_const_iterator:

Public Member Functions
	Generator_System_const_iterator ()
	Default constructor. More...
	Generator_System_const_iterator (const Generator_System_const_iterator &y)
	Ordinary copy constructor. More...
	~Generator_System_const_iterator ()
	Destructor. More...
Generator_System_const_iterator &	operator= (const Generator_System_const_iterator &y)
	Assignment operator. More...
const Generator &	operator* () const
	Dereference operator. More...
const Generator *	operator-> () const
	Indirect member selector. More...
Generator_System_const_iterator &	operator++ ()
	Prefix increment operator. More...
Generator_System_const_iterator	operator++ (int)
	Postfix increment operator. More...
bool	operator== (const Generator_System_const_iterator &y) const
	Returns true if and only if *this and y are identical. More...
bool	operator!= (const Generator_System_const_iterator &y) const
	Returns true if and only if *this and y are different. More...

Private Member Functions
	Generator_System_const_iterator (const Linear_System< Generator >::const_iterator &iter, const Generator_System &gsys)
	Constructor. More...
void	skip_forward ()
	*this skips to the next generator, skipping those closure points that are immediately followed by a matching point. More...

Private Attributes
Linear_System< Generator >::const_iterator	i
	The const iterator over the Linear_System. More...
const Linear_System< Generator > *	gsp
	A const pointer to the Linear_System. More...

Friends
class	Generator_System

Detailed Description

An iterator over a system of generators.

A const_iterator is used to provide read-only access to each generator contained in an object of Generator_System.

Example

The following code prints the system of generators of the polyhedron ph:

const Generator_System& gs = ph.generators();
for (Generator_System::const_iterator i = gs.begin(),
        gs_end = gs.end(); i != gs_end; ++i)
  cout << *i << endl;

The same effect can be obtained more concisely by using more features of the STL:

const Generator_System& gs = ph.generators();
copy(gs.begin(), gs.end(), ostream_iterator<Generator>(cout, "\n"));

Definition at line 680 of file Generator_System_defs.hh.

Constructor & Destructor Documentation

Parma_Polyhedra_Library::Generator_System_const_iterator::Generator_System_const_iterator ( )

inline

Default constructor.

Definition at line 291 of file Generator_System_inlines.hh.

  : i(), gsp(0) {
}

Parma_Polyhedra_Library::Generator_System_const_iterator::Generator_System_const_iterator ( const Generator_System_const_iterator &  y )

inline

Ordinary copy constructor.

Definition at line 296 of file Generator_System_inlines.hh.

  : i(y.i), gsp(y.gsp) {
}

Parma_Polyhedra_Library::Generator_System_const_iterator::~Generator_System_const_iterator ( )

inline

Destructor.

Definition at line 301 of file Generator_System_inlines.hh.

                                                                  {
}

Parma_Polyhedra_Library::Generator_System_const_iterator::Generator_System_const_iterator ( const Linear_System< Generator >::const_iterator &  iter, const Generator_System &  gsys  )

inlineprivate

Constructor.

Definition at line 350 of file Generator_System_inlines.hh.

  : i(iter), gsp(&gs.sys) {
}

Member Function Documentation

bool Parma_Polyhedra_Library::Generator_System_const_iterator::operator!= ( const Generator_System_const_iterator &  y ) const

inline

Returns true if and only if *this and y are different.

Definition at line 344 of file Generator_System_inlines.hh.

References i.

                                                                                          {
  return i != y.i;
}

const Generator & Parma_Polyhedra_Library::Generator_System_const_iterator::operator* ( ) const

inline

Dereference operator.

Definition at line 313 of file Generator_System_inlines.hh.

References i.

                                                 {
  return *i;
}

Generator_System_const_iterator & Parma_Polyhedra_Library::Generator_System_const_iterator::operator++ ( )

inline

Prefix increment operator.

Definition at line 323 of file Generator_System_inlines.hh.

References gsp, i, and skip_forward().

Referenced by operator++().

                                            {
  ++i;
  if (!gsp->is_necessarily_closed()) {
    skip_forward();
  }
  return *this;
}

Generator_System_const_iterator Parma_Polyhedra_Library::Generator_System_const_iterator::operator++ ( int  )

inline

Postfix increment operator.

Definition at line 332 of file Generator_System_inlines.hh.

References operator++().

                                               {
  const Generator_System_const_iterator tmp = *this;
  operator++();
  return tmp;
}

const Generator * Parma_Polyhedra_Library::Generator_System_const_iterator::operator-> ( ) const

inline

Indirect member selector.

Definition at line 318 of file Generator_System_inlines.hh.

References i.

                                                  {
  return i.operator->();
}

Generator_System_const_iterator & Parma_Polyhedra_Library::Generator_System_const_iterator::operator= ( const Generator_System_const_iterator &  y )

inline

Assignment operator.

Definition at line 306 of file Generator_System_inlines.hh.

References gsp, and i.

                                                                                   {
  i = y.i;
  gsp = y.gsp;
  return *this;
}

bool Parma_Polyhedra_Library::Generator_System_const_iterator::operator== ( const Generator_System_const_iterator &  y ) const

inline

Returns true if and only if *this and y are identical.

Definition at line 339 of file Generator_System_inlines.hh.

References i.

                                                                                          {
  return i == y.i;
}

void Parma_Polyhedra_Library::Generator_System_const_iterator::skip_forward ( )

private

*this skips to the next generator, skipping those closure points that are immediately followed by a matching point.

Definition at line 188 of file Generator_System.cc.

References Parma_Polyhedra_Library::Generator::is_closure_point(), Parma_Polyhedra_Library::Generator::is_matching_closure_point(), and Parma_Polyhedra_Library::Generator::is_point().

Referenced by Parma_Polyhedra_Library::Generator_System::begin(), and operator++().

                                                 {
  const Linear_System<Generator>::const_iterator gsp_end = gsp->end();
  if (i != gsp_end) {
    Linear_System<Generator>::const_iterator i_next = i;
    ++i_next;
    if (i_next != gsp_end) {
      const Generator& cp = *i;
      const Generator& p = *i_next;
      if (cp.is_closure_point()
          && p.is_point()
          && cp.is_matching_closure_point(p)) {
        i = i_next;
      }
    }
  }
}

Friends And Related Function Documentation

friend class Generator_System

friend

Definition at line 724 of file Generator_System_defs.hh.

Member Data Documentation

const Linear_System<Generator>* Parma_Polyhedra_Library::Generator_System_const_iterator::gsp

private

A const pointer to the Linear_System.

Definition at line 730 of file Generator_System_defs.hh.

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

Linear_System<Generator>::const_iterator Parma_Polyhedra_Library::Generator_System_const_iterator::i

private

The const iterator over the Linear_System.

Definition at line 727 of file Generator_System_defs.hh.

Referenced by operator!=(), operator*(), operator++(), operator->(), operator=(), and operator==().

---

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

• Generator_System_defs.hh
• Generator_System.cc
• Generator_System_inlines.hh