Sparse_Row_defs.hh

Go to the documentation of this file.

/* Sparse_Row 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_Sparse_Row_defs_hh
#define PPL_Sparse_Row_defs_hh 1

#include "Sparse_Row_types.hh"

#include "CO_Tree_defs.hh"
#include "Coefficient_defs.hh"
#include "Dense_Row_types.hh"

#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS

#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS)
class Parma_Polyhedra_Library::Sparse_Row {

public:


  typedef CO_Tree::iterator iterator;


  typedef CO_Tree::const_iterator const_iterator;


  explicit Sparse_Row(dimension_type n = 0);


  Sparse_Row(dimension_type n, dimension_type capacity);


  Sparse_Row(const Sparse_Row& y, dimension_type capacity);


  Sparse_Row(const Sparse_Row& y, dimension_type sz, dimension_type capacity);


  explicit Sparse_Row(const Dense_Row& row);


  Sparse_Row(const Dense_Row& y, dimension_type sz, dimension_type capacity);

  Sparse_Row& operator=(const Dense_Row& row);


  void m_swap(Sparse_Row& x);


  dimension_type size() const;


  dimension_type num_stored_elements() const;


  void resize(dimension_type n);


  void expand_within_capacity(dimension_type n);


  void shrink(dimension_type n);

  void delete_element_and_shift(dimension_type i);


  void add_zeroes_and_shift(dimension_type n, dimension_type i);


  iterator begin();


  const iterator& end();

  const_iterator begin() const;

  const const_iterator& end() const;


  const_iterator cbegin() const;


  const const_iterator& cend() const;

  static dimension_type max_size();


  void clear();


  Coefficient& operator[](dimension_type i);


  Coefficient_traits::const_reference operator[](dimension_type i) const;


  Coefficient_traits::const_reference get(dimension_type i) const;


  iterator find(dimension_type i);


  iterator find(iterator itr, dimension_type i);


  const_iterator find(dimension_type i) const;


  const_iterator find(const_iterator itr, dimension_type i) const;


  iterator lower_bound(dimension_type i);


  iterator lower_bound(iterator itr, dimension_type i);


  const_iterator lower_bound(dimension_type i) const;


  const_iterator lower_bound(const_iterator itr, dimension_type i) const;


  iterator insert(dimension_type i, Coefficient_traits::const_reference x);


  iterator insert(iterator itr, dimension_type i,
                  Coefficient_traits::const_reference x);


  iterator insert(dimension_type i);


  iterator insert(iterator itr, dimension_type i);


  void swap_coefficients(dimension_type i, dimension_type j);


  void fast_swap(dimension_type i, iterator itr);


  void swap_coefficients(iterator i, iterator j);


  iterator reset(iterator i);


  iterator reset(iterator first, iterator last);


  void reset(dimension_type i);


  void reset_after(dimension_type i);


  void normalize();


  template <typename Func1, typename Func2>
  void combine_needs_first(const Sparse_Row& y,
                           const Func1& f, const Func2& g);


  template <typename Func1, typename Func2>
  void combine_needs_second(const Sparse_Row& y,
                            const Func1& g, const Func2& h);


  template <typename Func1, typename Func2, typename Func3>
  void combine(const Sparse_Row& y,
               const Func1& f, const Func2& g, const Func3& h);


  void linear_combine(const Sparse_Row& y,
                      Coefficient_traits::const_reference coeff1,
                      Coefficient_traits::const_reference coeff2);


  void linear_combine(const Sparse_Row& y,
                      Coefficient_traits::const_reference c1,
                      Coefficient_traits::const_reference c2,
                      dimension_type start, dimension_type end);

  PPL_OUTPUT_DECLARATIONS


  bool ascii_load(std::istream& s);


  memory_size_type external_memory_in_bytes() const;


  memory_size_type external_memory_in_bytes(dimension_type capacity) const;


  memory_size_type total_memory_in_bytes() const;


  memory_size_type total_memory_in_bytes(dimension_type capacity) const;

  bool OK() const;


  bool OK(dimension_type capacity) const;

private:
  CO_Tree tree;


  dimension_type size_;
};


namespace Parma_Polyhedra_Library {

#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS

#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS)
void swap(Parma_Polyhedra_Library::Sparse_Row& x,
          Parma_Polyhedra_Library::Sparse_Row& y);

void swap(Parma_Polyhedra_Library::Sparse_Row& x,
          Parma_Polyhedra_Library::Dense_Row& y);

void swap(Parma_Polyhedra_Library::Dense_Row& x,
          Parma_Polyhedra_Library::Sparse_Row& y);

#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS

#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS)
bool operator==(const Sparse_Row& x, const Sparse_Row& y);

#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS

#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS)
bool operator!=(const Sparse_Row& x, const Sparse_Row& y);

bool operator==(const Dense_Row& x, const Sparse_Row& y);
bool operator!=(const Dense_Row& x, const Sparse_Row& y);

bool operator==(const Sparse_Row& x, const Dense_Row& y);
bool operator!=(const Sparse_Row& x, const Dense_Row& y);

#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS

#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS)
void linear_combine(Sparse_Row& x, const Dense_Row& y,
                    Coefficient_traits::const_reference coeff1,
                    Coefficient_traits::const_reference coeff2);

#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS

#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS)
void linear_combine(Sparse_Row& x, const Dense_Row& y,
                    Coefficient_traits::const_reference c1,
                    Coefficient_traits::const_reference c2,
                    dimension_type start, dimension_type end);

#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS

#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS)
void linear_combine(Dense_Row& x, const Sparse_Row& y,
                    Coefficient_traits::const_reference coeff1,
                    Coefficient_traits::const_reference coeff2);

#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS

#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS)
void linear_combine(Dense_Row& x, const Sparse_Row& y,
                    Coefficient_traits::const_reference c1,
                    Coefficient_traits::const_reference c2,
                    dimension_type start, dimension_type end);

#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS

#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS)
void linear_combine(Sparse_Row& x, const Sparse_Row& y,
                    Coefficient_traits::const_reference coeff1,
                    Coefficient_traits::const_reference coeff2);

#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS

#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS)
void linear_combine(Sparse_Row& x, const Sparse_Row& y,
                    Coefficient_traits::const_reference c1,
                    Coefficient_traits::const_reference c2,
                    dimension_type start, dimension_type end);

} // namespace Parma_Polyhedra_Library

#include "Sparse_Row_inlines.hh"
#include "Sparse_Row_templates.hh"

#endif // !defined(PPL_Sparse_Row_defs_hh)