Linear_Form_defs.hh

Go to the documentation of this file.

/* Linear_Form 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_Linear_Form_defs_hh
#define PPL_Linear_Form_defs_hh 1

#include "Linear_Form_types.hh"
#include "Linear_Expression_types.hh"
#include "Variable_defs.hh"
#include "Box_types.hh"
#include "Float_defs.hh"
#include <vector>

namespace Parma_Polyhedra_Library {


template <typename C>
void swap(Linear_Form<C>& x, Linear_Form<C>& y);

// Put them in the namespace here to declare them friend later.


template <typename C>
Linear_Form<C>
operator+(const Linear_Form<C>& f1, const Linear_Form<C>& f2);


template <typename C>
Linear_Form<C>
operator+(Variable v, const Linear_Form<C>& f);


template <typename C>
Linear_Form<C>
operator+(const Linear_Form<C>& f, Variable v);


template <typename C>
Linear_Form<C>
operator+(const C& n, const Linear_Form<C>& f);


template <typename C>
Linear_Form<C>
operator+(const Linear_Form<C>& f, const C& n);


template <typename C>
Linear_Form<C>
operator+(const Linear_Form<C>& f);


template <typename C>
Linear_Form<C>
operator-(const Linear_Form<C>& f);


template <typename C>
Linear_Form<C>
operator-(const Linear_Form<C>& f1, const Linear_Form<C>& f2);


template <typename C>
Linear_Form<C>
operator-(Variable v, const Linear_Form<C>& f);


template <typename C>
Linear_Form<C>
operator-(const Linear_Form<C>& f, Variable v);


template <typename C>
Linear_Form<C>
operator-(const C& n, const Linear_Form<C>& f);


template <typename C>
Linear_Form<C>
operator-(const Linear_Form<C>& f, const C& n);


template <typename C>
Linear_Form<C>
operator*(const C& n, const Linear_Form<C>& f);


template <typename C>
Linear_Form<C>
operator*(const Linear_Form<C>& f, const C& n);


template <typename C>
Linear_Form<C>&
operator+=(Linear_Form<C>& f1, const Linear_Form<C>& f2);


template <typename C>
Linear_Form<C>&
operator+=(Linear_Form<C>& f, Variable v);


template <typename C>
Linear_Form<C>&
operator+=(Linear_Form<C>& f, const C& n);


template <typename C>
Linear_Form<C>&
operator-=(Linear_Form<C>& f1, const Linear_Form<C>& f2);


template <typename C>
Linear_Form<C>&
operator-=(Linear_Form<C>& f, Variable v);


template <typename C>
Linear_Form<C>&
operator-=(Linear_Form<C>& f, const C& n);


template <typename C>
Linear_Form<C>&
operator*=(Linear_Form<C>& f, const C& n);


template <typename C>
Linear_Form<C>&
operator/=(Linear_Form<C>& f, const C& n);


template <typename C>
bool
operator==(const Linear_Form<C>& x, const Linear_Form<C>& y);


template <typename C>
bool
operator!=(const Linear_Form<C>& x, const Linear_Form<C>& y);

namespace IO_Operators {


template <typename C>
std::ostream& operator<<(std::ostream& s, const Linear_Form<C>& f);

} // namespace IO_Operators

} // namespace Parma_Polyhedra_Library


template <typename C>
class Parma_Polyhedra_Library::Linear_Form {
public:
  Linear_Form();

  Linear_Form(const Linear_Form& f);

  ~Linear_Form();

  explicit Linear_Form(const C& n);


  Linear_Form(Variable v);

  Linear_Form(const Linear_Expression& e);

  static dimension_type max_space_dimension();

  dimension_type space_dimension() const;

  const C& coefficient(Variable v) const;

  const C& inhomogeneous_term() const;

  void negate();

  memory_size_type total_memory_in_bytes() const;

  memory_size_type external_memory_in_bytes() const;

  PPL_OUTPUT_DECLARATIONS

  bool ascii_load(std::istream& s);

  bool OK() const;

  void m_swap(Linear_Form& y);

  // Floating point analysis related methods.

  bool overflows() const;

  void relative_error(Floating_Point_Format analyzed_format,
                      Linear_Form& result) const;

  template <typename Target>
  bool intervalize(const FP_Oracle<Target,C>& oracle, C& result) const;

private:
  static C zero;

  typedef std::vector<C> vec_type;

  vec_type vec;


  Linear_Form(dimension_type sz, bool);

  Linear_Form(Variable v, Variable w);

  dimension_type size() const;

  void extend(dimension_type sz);

  C& operator[](dimension_type i);

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

  friend Linear_Form<C>
  operator+<C>(const Linear_Form<C>& f1, const Linear_Form<C>& f2);
  friend Linear_Form<C>
  operator+<C>(const C& n, const Linear_Form<C>& f);
  friend Linear_Form<C>
  operator+<C>(const Linear_Form<C>& f, const C& n);
  friend Linear_Form<C>
  operator+<C>(Variable v, const Linear_Form<C>& f);

  friend Linear_Form<C>
  operator-<C>(const Linear_Form<C>& f);

  friend Linear_Form<C>
  operator-<C>(const Linear_Form<C>& f1, const Linear_Form<C>& f2);
  friend Linear_Form<C>
  operator-<C>(const C& n, const Linear_Form<C>& f);
  friend Linear_Form<C>
  operator-<C>(const Linear_Form<C>& f, const C& n);
  friend Linear_Form<C>
  operator-<C>(Variable v, const Linear_Form<C>& f);
  friend Linear_Form<C>
  operator-<C>(const Linear_Form<C>& f, Variable v);

  friend Linear_Form<C>
  operator*<C>(const C& n, const Linear_Form<C>& f);
  friend Linear_Form<C>
  operator*<C>(const Linear_Form<C>& f, const C& n);

  friend Linear_Form<C>&
  operator+=<C>(Linear_Form<C>& f1, const Linear_Form<C>& f2);
  friend Linear_Form<C>&
  operator+=<C>(Linear_Form<C>& f, Variable v);
  friend Linear_Form<C>&
  operator+=<C>(Linear_Form<C>& f, const C& n);

  friend Linear_Form<C>&
  operator-=<C>(Linear_Form<C>& f1, const Linear_Form<C>& f2);
  friend Linear_Form<C>&
  operator-=<C>(Linear_Form<C>& f, Variable v);
  friend Linear_Form<C>&
  operator-=<C>(Linear_Form<C>& f, const C& n);

  friend Linear_Form<C>&
  operator*=<C>(Linear_Form<C>& f, const C& n);

  friend Linear_Form<C>&
  operator/=<C>(Linear_Form<C>& f, const C& n);

  friend bool
  operator==<C>(const Linear_Form<C>& x, const Linear_Form<C>& y);

  friend std::ostream&
  Parma_Polyhedra_Library::IO_Operators
  ::operator<<<C>(std::ostream& s, const Linear_Form<C>& f);
};

#include "Linear_Form_inlines.hh"
// Linear_Form_templates.hh is not included here on purpose.

#endif // !defined(PPL_Linear_Form_defs_hh)