Matrix_defs.hh

Go to the documentation of this file.

/* Matrix 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_Matrix_defs_hh
#define PPL_Matrix_defs_hh 1

#include "Matrix_types.hh"
#include "globals_defs.hh"
#include "Coefficient_defs.hh"
#include "Swapping_Vector_defs.hh"
#include <ostream>

#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS
#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS)
template <typename Row>
class Parma_Polyhedra_Library::Matrix {

public:
  typedef typename Swapping_Vector<Row>::iterator iterator;
  typedef typename Swapping_Vector<Row>::const_iterator const_iterator;

  static dimension_type max_num_rows();

  static dimension_type max_num_columns();

  explicit Matrix(dimension_type n = 0);

  Matrix(dimension_type num_rows, dimension_type num_columns);


  void m_swap(Matrix& x);


  dimension_type num_rows() const;


  dimension_type num_columns() const;

  // TODO: Check if this can be removed.
  dimension_type capacity() const;


  bool has_no_rows() const;

  void resize(dimension_type n);

  // TODO: Check if this can become private.
  void reserve_rows(dimension_type n);


  void resize(dimension_type num_rows, dimension_type num_columns);


  void add_zero_rows_and_columns(dimension_type n, dimension_type m);


  void add_zero_rows(dimension_type n);


  void add_row(const Row& x);


  void add_recycled_row(Row& y);

  void remove_trailing_rows(dimension_type n);

  void remove_rows(iterator first, iterator last);


  void permute_columns(const std::vector<dimension_type>& cycles);

  void swap_columns(dimension_type i,  dimension_type j);


  void add_zero_columns(dimension_type n);


  void add_zero_columns(dimension_type n, dimension_type i);


  void remove_column(dimension_type i);


  void remove_trailing_columns(dimension_type n);

  void clear();


  iterator begin();


  iterator end();


  const_iterator begin() const;


  const_iterator end() const;


  Row& operator[](dimension_type i);


  const Row& operator[](dimension_type i) const;


  bool ascii_load(std::istream& s);

  PPL_OUTPUT_DECLARATIONS


  memory_size_type total_memory_in_bytes() const;


  memory_size_type external_memory_in_bytes() const;

  bool OK() const;

private:
  Swapping_Vector<Row> rows;

  dimension_type num_columns_;
};

namespace Parma_Polyhedra_Library {

#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS

#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS)
template <typename Row>
void swap(Matrix<Row>& x, Matrix<Row>& y);

#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS

#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS)
template <typename Row>
bool operator==(const Matrix<Row>& x, const Matrix<Row>& y);

#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS

#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS)
template <typename Row>
bool operator!=(const Matrix<Row>& x, const Matrix<Row>& y);

} // namespace Parma_Polyhedra_Library


#include "Matrix_inlines.hh"
#include "Matrix_templates.hh"

#endif // !defined(PPL_Matrix_defs_hh)