Congruence_System_defs.hh

Go to the documentation of this file.

/* Congruence_System class declaration.
   Copyright (C) 2001-2010 Roberto Bagnara <bagnara@cs.unipr.it>
   Copyright (C) 2010-2016 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_Congruence_System_defs_hh
#define PPL_Congruence_System_defs_hh 1

#include "Congruence_System_types.hh"
#include "Linear_Expression_types.hh"
#include "Constraint_types.hh"
#include "Congruence_types.hh"
#include "Grid_Generator_types.hh"
#include "Swapping_Vector_defs.hh"
#include "Congruence_defs.hh"
#include "Constraint_System_types.hh"
#include <iosfwd>
#include <cstddef>

namespace Parma_Polyhedra_Library {

bool
operator==(const Congruence_System& x, const Congruence_System& y);

}


class Parma_Polyhedra_Library::Congruence_System {
public:

  typedef Congruence row_type;

  static const Representation default_representation = SPARSE;

  explicit Congruence_System(Representation r = default_representation);

  explicit Congruence_System(dimension_type d,
                             Representation r = default_representation);

  explicit Congruence_System(const Congruence& cg,
                             Representation r = default_representation);

  explicit Congruence_System(const Constraint& c,
                             Representation r = default_representation);

  explicit Congruence_System(const Constraint_System& cs,
                             Representation r = default_representation);


  Congruence_System(const Congruence_System& cgs);

  Congruence_System(const Congruence_System& cgs, Representation r);

  ~Congruence_System();

  Congruence_System& operator=(const Congruence_System& y);

  Representation representation() const;

  void set_representation(Representation r);

  static dimension_type max_space_dimension();

  dimension_type space_dimension() const;

  bool is_equal_to(const Congruence_System& y) const;

  bool has_linear_equalities() const;

  void clear();

  void insert(const Congruence& cg);

  void insert(Congruence& cg, Recycle_Input);

  void insert(const Constraint& c);

  // TODO: Consider adding a insert(cg, Recycle_Input).

  void insert(const Congruence_System& y);

  void insert(Congruence_System& cgs, Recycle_Input);

  static void initialize();

  static void finalize();

  static const Congruence_System& zero_dim_empty();


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

    const_iterator(const const_iterator& y);

    ~const_iterator();

    const_iterator& operator=(const const_iterator& y);

    const Congruence& operator*() const;

    const Congruence* 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 Congruence_System;

    Swapping_Vector<Congruence>::const_iterator i;

    const Swapping_Vector<Congruence>* csp;

    const_iterator(const Swapping_Vector<Congruence>::const_iterator& iter,
                   const Congruence_System& cgs);

    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;

  dimension_type num_equalities() const;

  dimension_type num_proper_congruences() const;

  void m_swap(Congruence_System& y);

  void add_unit_rows_and_space_dimensions(dimension_type dims);


  void permute_space_dimensions(const std::vector<Variable>& cycle);

  void swap_space_dimensions(Variable v1, Variable v2);


  bool set_space_dimension(dimension_type new_space_dim);

  // Note: the following method is protected to allow tests/Grid/congruences2
  // to call it using a derived class.
protected:
  bool satisfies_all_congruences(const Grid_Generator& g) const;

private:
  dimension_type num_rows() const;

  bool has_no_rows() const;

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

  void normalize_moduli();

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

  // TODO: Consider making this private.
  void concatenate(const Congruence_System& y);

  void insert_verbatim(Congruence& cg, Recycle_Input);


  void remove_rows(dimension_type first, dimension_type last,
                   bool keep_sorted);

  void remove_trailing_rows(dimension_type n);

  static const Congruence_System* zero_dim_empty_p;

  Swapping_Vector<Congruence> rows;

  dimension_type space_dimension_;

  Representation representation_;

  bool has_a_free_dimension() const;

  friend class Grid;

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

namespace Parma_Polyhedra_Library {

namespace IO_Operators {


std::ostream&
operator<<(std::ostream& s, const Congruence_System& cgs);

} // namespace IO_Operators

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

} // namespace Parma_Polyhedra_Library

// Congruence_System_inlines.hh is not included here on purpose.

#endif // !defined(PPL_Congruence_System_defs_hh)