Variable.defs.hh

Go to the documentation of this file.

/* Variable class declaration.
   Copyright (C) 2001-2010 Roberto Bagnara <bagnara@cs.unipr.it>
   Copyright (C) 2010-2012 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_Variable_defs_hh
#define PPL_Variable_defs_hh 1

#include "Variable.types.hh"
#include "Init.types.hh"
#include "globals.types.hh"
#include <iosfwd>
#include <set>

namespace Parma_Polyhedra_Library {

namespace IO_Operators {


std::ostream&
operator<<(std::ostream& s, const Variable v);

} // namespace IO_Operators


bool less(Variable v, Variable w);

} // namespace Parma_Polyhedra_Library


class Parma_Polyhedra_Library::Variable {

public:

  explicit Variable(dimension_type i);

  dimension_type id() const;

  static dimension_type max_space_dimension();


  dimension_type space_dimension() const;

  memory_size_type total_memory_in_bytes() const;

  memory_size_type external_memory_in_bytes() const;

  bool OK() const;

  typedef void output_function_type(std::ostream& s, const Variable v);

  static void set_output_function(output_function_type* p);

  static output_function_type* get_output_function();


  struct Compare {
    bool operator()(Variable x, Variable y) const;
  };

private:
  dimension_type varid;

  // The initialization class needs to set the default output function.
  friend class Init;

  friend std::ostream&
  Parma_Polyhedra_Library::IO_Operators::operator<<(std::ostream& s,
                                                    const Variable v);

  static output_function_type* current_output_function;

  static void default_output_function(std::ostream& s, const Variable v);
};

#include "Variable.inlines.hh"

#endif // !defined(PPL_Variable_defs_hh)