Grid_Generator_System_defs.hh

Go to the documentation of this file.

/* Grid_Generator_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_Grid_Generator_System_defs_hh
#define PPL_Grid_Generator_System_defs_hh 1

#include "Grid_Generator_System_types.hh"

#include "Linear_System_defs.hh"
#include "Grid_Generator_defs.hh"
#include "Variables_Set_types.hh"
#include "Polyhedron_types.hh"
#include <iosfwd>
#include <cstddef>

namespace Parma_Polyhedra_Library {

namespace IO_Operators {


std::ostream& operator<<(std::ostream& s, const Grid_Generator_System& gs);

} // namespace IO_Operators


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


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

} // namespace Parma_Polyhedra_Library


class Parma_Polyhedra_Library::Grid_Generator_System {
public:
  typedef Grid_Generator row_type;

  static const Representation default_representation = SPARSE;

  explicit Grid_Generator_System(Representation r = default_representation);

  explicit Grid_Generator_System(const Grid_Generator& g,
                                 Representation r = default_representation);

  explicit Grid_Generator_System(dimension_type dim,
                                 Representation r = default_representation);

  Grid_Generator_System(const Grid_Generator_System& gs);

  Grid_Generator_System(const Grid_Generator_System& gs, Representation r);

  ~Grid_Generator_System();

  Grid_Generator_System& operator=(const Grid_Generator_System& y);

  Representation representation() const;

  void set_representation(Representation r);

  static dimension_type max_space_dimension();

  dimension_type space_dimension() const;

  void clear();

  void insert(const Grid_Generator& g);

  void insert(Grid_Generator& g, Recycle_Input);

  void insert(Grid_Generator_System& gs, Recycle_Input);

  static void initialize();

  static void finalize();

  static const Grid_Generator_System& zero_dim_univ();


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

    const_iterator(const const_iterator& y);

    ~const_iterator();

    const_iterator& operator=(const const_iterator& y);

    const Grid_Generator& operator*() const;

    const Grid_Generator* 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 Grid_Generator_System;

    Linear_System<Grid_Generator>::const_iterator i;

    const_iterator(const Linear_System<Grid_Generator>::const_iterator& y);
  };

  bool empty() const;

  const_iterator begin() const;

  const_iterator end() const;

  dimension_type num_rows() const;

  dimension_type num_parameters() const;

  dimension_type num_lines() const;

  bool has_points() const;

  bool is_equal_to(const Grid_Generator_System& y) const;

  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(Grid_Generator_System& y);

private:
  const Grid_Generator& operator[](dimension_type k) const;


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

  void set_sorted(bool b);

  void add_universe_rows_and_columns(dimension_type dims);

  void set_space_dimension(dimension_type space_dim);


  void remove_space_dimensions(const Variables_Set& vars);

  void shift_space_dimensions(Variable v, dimension_type n);

  void unset_pending_rows();

  /*
    \param cycle
    A vector representing a cycle of the permutation according to which the
    columns must be rearranged.

    The \p cycle vector represents a cycle of a permutation of space
    dimensions.
    For example, the permutation
    \f$ \{ x_1 \mapsto x_2, x_2 \mapsto x_3, x_3 \mapsto x_1 \}\f$ can be
    represented by the vector containing \f$ x_1, x_2, x_3 \f$.
  */
  void permute_space_dimensions(const std::vector<Variable>& cycle);

  bool has_no_rows() const;

  void remove_trailing_rows(dimension_type n);

  void insert_verbatim(const Grid_Generator& g);

  Topology topology() const;

  dimension_type first_pending_row() const;

  Linear_System<Grid_Generator> sys;

  static const Grid_Generator_System* zero_dim_univ_p;

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

  void set_index_first_pending_row(dimension_type i);


  void remove_invalid_lines_and_parameters();

  friend class Polyhedron;
  friend class Grid;
};

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

#endif // !defined(PPL_Grid_Generator_System_defs_hh)