Dense_Row_defs.hh

Go to the documentation of this file.

/* Dense_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_Dense_Row_defs_hh
#define PPL_Dense_Row_defs_hh 1

#include "Dense_Row_types.hh"

#include "globals_defs.hh"

#include "Sparse_Row_types.hh"
#include "Coefficient_defs.hh"
#include <memory>
#include <vector>
#include <limits>
#include <cstddef>

#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS

#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS)
class Parma_Polyhedra_Library::Dense_Row {
public:
  class iterator;
  class const_iterator;

  Dense_Row();

  explicit Dense_Row(const Sparse_Row& row);


  Dense_Row(dimension_type sz);


  Dense_Row(dimension_type sz, dimension_type capacity);

  Dense_Row(const Dense_Row& y);


  Dense_Row(const Dense_Row& y, dimension_type capacity);


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


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

  ~Dense_Row();

  Dense_Row& operator=(const Dense_Row& y);

  Dense_Row& operator=(const Sparse_Row& y);

  void m_swap(Dense_Row& y);

  void resize(dimension_type sz);

  void resize(dimension_type sz, dimension_type capacity);

  void clear();


  void add_zeroes_and_shift(dimension_type n, dimension_type i);


  void expand_within_capacity(dimension_type new_size);


  void shrink(dimension_type new_size);

  static dimension_type max_size();

  dimension_type size() const;


  Coefficient& operator[](dimension_type k);

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


  void normalize();

  void swap_coefficients(dimension_type i, dimension_type j);

  void swap_coefficients(iterator i, iterator j);

  iterator begin();
  const_iterator begin() const;

  iterator end();
  const_iterator end() const;

  void reset(dimension_type i);

  void reset(dimension_type first, dimension_type last);

  iterator reset(iterator itr);

  Coefficient_traits::const_reference get(dimension_type i) const;

  iterator find(dimension_type i);

  const_iterator find(dimension_type i) const;

  iterator find(iterator itr, dimension_type i);

  const_iterator find(const_iterator itr, dimension_type i) const;

  iterator lower_bound(dimension_type i);

  const_iterator lower_bound(dimension_type i) const;

  iterator lower_bound(iterator itr, dimension_type i);

  const_iterator lower_bound(const_iterator itr, dimension_type i) const;

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

  iterator insert(dimension_type i);

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

  iterator insert(iterator itr, dimension_type i);


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


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


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


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


  void linear_combine(const Dense_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 total_memory_in_bytes() const;

  memory_size_type external_memory_in_bytes() const;

  memory_size_type total_memory_in_bytes(dimension_type capacity) const;

  memory_size_type external_memory_in_bytes(dimension_type capacity) const;

  bool OK() const;

  bool OK(dimension_type row_size) const;

private:
  void init(const Sparse_Row& row);

  void destroy();

  struct Impl {

    Impl();

    ~Impl();

    dimension_type size;

    dimension_type capacity;

    std::allocator<Coefficient> coeff_allocator;

    Coefficient* vec;
  };

  Impl impl;

  dimension_type capacity() const;
};

class Parma_Polyhedra_Library::Dense_Row::iterator {
public:

  typedef std::bidirectional_iterator_tag iterator_category;
  typedef Coefficient value_type;
  typedef std::ptrdiff_t difference_type;
  typedef value_type* pointer;
  typedef value_type& reference;

  iterator();
  iterator(Dense_Row& r, dimension_type i);

  Coefficient& operator*();
  Coefficient_traits::const_reference operator*() const;


  dimension_type index() const;

  iterator& operator++();
  iterator operator++(int);

  iterator& operator--();
  iterator operator--(int);

  bool operator==(const iterator& x) const;
  bool operator!=(const iterator& x) const;

  operator const_iterator() const;

  bool OK() const;

private:
  Dense_Row* row;
  dimension_type idx;
};

class Parma_Polyhedra_Library::Dense_Row::const_iterator {
public:

  typedef const Coefficient value_type;
  typedef std::ptrdiff_t difference_type;
  typedef value_type* pointer;
  typedef Coefficient_traits::const_reference reference;

  const_iterator();
  const_iterator(const Dense_Row& r, dimension_type i);

  Coefficient_traits::const_reference operator*() const;


  dimension_type index() const;

  const_iterator& operator++();
  const_iterator operator++(int);

  const_iterator& operator--();
  const_iterator operator--(int);

  bool operator==(const const_iterator& x) const;
  bool operator!=(const const_iterator& x) const;

  bool OK() const;

private:
  const Dense_Row* row;
  dimension_type idx;
};


namespace Parma_Polyhedra_Library {

#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS

#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS)
void swap(Dense_Row& x, Dense_Row& y);

#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS

#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS)
void iter_swap(std::vector<Dense_Row>::iterator x,
               std::vector<Dense_Row>::iterator y);

#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS

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

#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS

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

#ifdef PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS

#endif // defined(PPL_DOXYGEN_INCLUDE_IMPLEMENTATION_DETAILS)
void linear_combine(Dense_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(Dense_Row& x, const Dense_Row& y,
                    Coefficient_traits::const_reference c1,
                    Coefficient_traits::const_reference c2,
                    dimension_type start, dimension_type end);

} // namespace Parma_Polyhedra_Library

#include "Dense_Row_inlines.hh"
#include "Dense_Row_templates.hh"

#endif // !defined(PPL_Dense_Row_defs_hh)