Constraint_System.defs.hh

Go to the documentation of this file.

/* Constraint_System class declaration.
   Copyright (C) 2001-2010 Roberto Bagnara <bagnara@cs.unipr.it>
   Copyright (C) 2010-2012 BUGSENG srl (http://bugseng.com)

This file is part of the Parma Polyhedra Library (PPL).

The PPL is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 3 of the License, or (at your
option) any later version.

The PPL is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software Foundation,
Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1307, USA.

For the most up-to-date information see the Parma Polyhedra Library
site: http://bugseng.com/products/ppl/ . */

#ifndef PPL_Constraint_System_defs_hh
#define PPL_Constraint_System_defs_hh 1

#include "Constraint_System.types.hh"
#include "Linear_Expression.types.hh"
#include "Linear_System.defs.hh"
#include "Generator.types.hh"
#include "Polyhedron.types.hh"
#include "Constraint.types.hh"
#include "Congruence_System.types.hh"
#include <iterator>
#include <iosfwd>

namespace Parma_Polyhedra_Library {

namespace IO_Operators {


std::ostream& operator<<(std::ostream& s, const Constraint_System& cs);

} // namespace IO_Operators


void swap(Constraint_System& x, Constraint_System& y);

// Put it in the namespace here to declare it friend later.
bool operator==(const Polyhedron& x, const Polyhedron& y);

} // namespace Parma_Polyhedra_Library


class Parma_Polyhedra_Library::Constraint_System : private Linear_System {
public:
  Constraint_System();

  explicit Constraint_System(const Constraint& c);

  explicit Constraint_System(const Congruence_System& cgs);

  Constraint_System(const Constraint_System& cs);

  ~Constraint_System();

  Constraint_System& operator=(const Constraint_System& y);

  static dimension_type max_space_dimension();

  dimension_type space_dimension() const;

  bool has_equalities() const;

  bool has_strict_inequalities() const;

  void clear();

  void insert(const Constraint& c);

  static void initialize();

  static void finalize();

  static const Constraint_System& zero_dim_empty();


  class const_iterator
    : public std::iterator<std::forward_iterator_tag,
                           Constraint,
                           ptrdiff_t,
                           const Constraint*,
                           const Constraint&> {
  public:
    const_iterator();

    const_iterator(const const_iterator& y);

    ~const_iterator();

    const_iterator& operator=(const const_iterator& y);

    const Constraint& operator*() const;

    const Constraint* operator->() const;

    const_iterator& operator++();

    const_iterator operator++(int);

    bool operator==(const const_iterator& y) const;

    bool operator!=(const const_iterator& y) const;

  private:
    friend class Constraint_System;

    Linear_System::const_iterator i;

    const Linear_System* csp;

    const_iterator(const Linear_System::const_iterator& iter,
                   const Constraint_System& cs);

    void skip_forward();
  };

  bool empty() const;

  const_iterator begin() const;

  const_iterator end() const;

#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS

#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS)
  bool OK() const;

  PPL_OUTPUT_DECLARATIONS

  bool ascii_load(std::istream& s);

  memory_size_type total_memory_in_bytes() const;

  memory_size_type external_memory_in_bytes() const;

  void m_swap(Constraint_System& y);

private:
  static const Constraint_System* zero_dim_empty_p;

  friend class const_iterator;
  friend class Parma_Polyhedra_Library::Polyhedron;

  friend bool operator==(const Polyhedron& x, const Polyhedron& y);

  explicit Constraint_System(Topology topol);

  Constraint_System(Topology topol,
                    dimension_type n_rows, dimension_type n_columns);

  bool adjust_topology_and_space_dimension(Topology new_topology,
                                           dimension_type new_space_dim);

  Constraint& operator[](dimension_type k);

  const Constraint& operator[](dimension_type k) const;

  bool satisfies_all_constraints(const Generator& g) const;


  void affine_preimage(dimension_type v,
                       const Linear_Expression& expr,
                       Coefficient_traits::const_reference denominator);

  dimension_type num_equalities() const;

  dimension_type num_inequalities() const;

  void simplify();

  void insert_pending(const Constraint& c);

  void add_low_level_constraints();
};

namespace Parma_Polyhedra_Library {

namespace Implementation {

#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS

#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS)
dimension_type
num_constraints(const Constraint_System& cs);

} // namespace Implementation

} // namespace Parma_Polyhedra_Library

// Constraint_System.inlines.hh is not included here on purpose.

#endif // !defined(PPL_Constraint_System_defs_hh)