PIP_Problem_defs.hh

Go to the documentation of this file.

/* PIP_Problem 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_PIP_Problem_defs_hh
#define PPL_PIP_Problem_defs_hh 1

#include "PIP_Problem_types.hh"
#include "PIP_Tree_types.hh"
#include "globals_types.hh"
#include "Linear_Expression_defs.hh"
#include "Matrix_defs.hh"
#include "Constraint_defs.hh"
#include "Constraint_System_types.hh"
#include "Generator_defs.hh"
#include "Variables_Set_defs.hh"
#include <vector>
#include <deque>
#include <iosfwd>

namespace Parma_Polyhedra_Library {

namespace IO_Operators {


std::ostream&
operator<<(std::ostream& s, const PIP_Problem& pip);

} // namespace IO_Operators


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

} // namespace Parma_Polyhedra_Library


class Parma_Polyhedra_Library::PIP_Problem {
public:

  explicit PIP_Problem(dimension_type dim = 0);

  template <typename In>
  PIP_Problem(dimension_type dim, In first, In last,
              const Variables_Set& p_vars);

  PIP_Problem(const PIP_Problem& y);

  ~PIP_Problem();

  PIP_Problem& operator=(const PIP_Problem& y);

  static dimension_type max_space_dimension();

  dimension_type space_dimension() const;

  const Variables_Set& parameter_space_dimensions() const;

private:
  typedef std::vector<Constraint> Constraint_Sequence;

public:
  typedef Constraint_Sequence::const_iterator const_iterator;

  const_iterator constraints_begin() const;

  const_iterator constraints_end() const;


  void clear();

  void add_space_dimensions_and_embed(dimension_type m_vars,
                                      dimension_type m_params);

  void add_to_parameter_space_dimensions(const Variables_Set& p_vars);

  void add_constraint(const Constraint& c);

  void add_constraints(const Constraint_System& cs);


  bool is_satisfiable() const;


  PIP_Problem_Status solve() const;


  PIP_Tree solution() const;


  PIP_Tree optimizing_solution() const;

  bool OK() const;


  void print_solution(std::ostream& s, int indent = 0) 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(PIP_Problem& y);

  enum Control_Parameter_Name {
    CUTTING_STRATEGY,
    PIVOT_ROW_STRATEGY,
#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS
#endif // PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS
    CONTROL_PARAMETER_NAME_SIZE
  };

  enum Control_Parameter_Value {
    CUTTING_STRATEGY_FIRST,
    CUTTING_STRATEGY_DEEPEST,
    CUTTING_STRATEGY_ALL,

    PIVOT_ROW_STRATEGY_FIRST,
    PIVOT_ROW_STRATEGY_MAX_COLUMN,

#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS
#endif // PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS
    CONTROL_PARAMETER_VALUE_SIZE
  };

  Control_Parameter_Value
  get_control_parameter(Control_Parameter_Name name) const;

  void set_control_parameter(Control_Parameter_Value value);

  void set_big_parameter_dimension(dimension_type big_dim);

  dimension_type get_big_parameter_dimension() const;

private:
  void control_parameters_init();

  void control_parameters_copy(const PIP_Problem& y);

  dimension_type external_space_dim;

  dimension_type internal_space_dim;

  enum Status {
    UNSATISFIABLE,
    OPTIMIZED,
    PARTIALLY_SATISFIABLE
  };

  Status status;

  PIP_Tree_Node* current_solution;

  Constraint_Sequence input_cs;

  dimension_type first_pending_constraint;

  Variables_Set parameters;

#if PPL_USE_SPARSE_MATRIX
  typedef Sparse_Row Row;
#else
  typedef Dense_Row Row;
#endif

  Matrix<Row> initial_context;

  Control_Parameter_Value
  control_parameters[CONTROL_PARAMETER_NAME_SIZE];

  dimension_type big_parameter_dimension;

  friend class PIP_Solution_Node;
};

#include "PIP_Problem_inlines.hh"
#include "PIP_Problem_templates.hh"

#endif // !defined(PPL_PIP_Problem_defs_hh)