PPL  1.2
Variable_inlines.hh
Go to the documentation of this file.
1 /* Variable class implementation: inline functions.
2  Copyright (C) 2001-2010 Roberto Bagnara <bagnara@cs.unipr.it>
3  Copyright (C) 2010-2016 BUGSENG srl (http://bugseng.com)
4 
5 This file is part of the Parma Polyhedra Library (PPL).
6 
7 The PPL is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 3 of the License, or (at your
10 option) any later version.
11 
12 The PPL is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 for more details.
16 
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software Foundation,
19 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1307, USA.
20 
21 For the most up-to-date information see the Parma Polyhedra Library
22 site: http://bugseng.com/products/ppl/ . */
23 
24 #ifndef PPL_Variable_inlines_hh
25 #define PPL_Variable_inlines_hh 1
26 
27 #include "globals_defs.hh"
28 #include <stdexcept>
29 
30 namespace Parma_Polyhedra_Library {
31 
32 inline dimension_type
34  return not_a_dimension() - 1;
35 }
36 
37 inline
39  : varid((i < max_space_dimension())
40  ? i
41  : (throw std::length_error("PPL::Variable::Variable(i):\n"
42  "i exceeds the maximum allowed "
43  "variable identifier."), i)) {
44 }
45 
46 inline dimension_type
47 Variable::id() const {
48  return varid;
49 }
50 
51 inline dimension_type
53  return varid + 1;
54 }
55 
56 inline memory_size_type
58  return 0;
59 }
60 
61 inline memory_size_type
63  return sizeof(*this) + external_memory_in_bytes();
64 }
65 
66 inline void
67 Variable::set_output_function(output_function_type* p) {
69 }
70 
74 }
75 
77 inline bool
78 less(const Variable v, const Variable w) {
79  return v.id() < w.id();
80 }
81 
82 inline bool
84  return less(x, y);
85 }
86 
87 inline void
89  using std::swap;
90  swap(varid, v.varid);
91 }
92 
93 inline void
95  x.m_swap(y);
96 }
97 
98 } // namespace Parma_Polyhedra_Library
99 
100 #endif // !defined(PPL_Variable_inlines_hh)
bool less(const Variable v, const Variable w)
void swap(Variable &x, Variable &y)
dimension_type max_space_dimension()
Returns the maximum space dimension this library can handle.
size_t dimension_type
An unsigned integral type for representing space dimensions.
dimension_type varid
The index of the Cartesian axis.
Variable(dimension_type i)
Builds the variable corresponding to the Cartesian axis of index i.
static output_function_type * get_output_function()
Returns the pointer to the current output function.
dimension_type not_a_dimension()
Returns a value that does not designate a valid dimension.
static dimension_type max_space_dimension()
Returns the maximum space dimension a Variable can handle.
The standard C++ namespace.
void output_function_type(std::ostream &s, const Variable v)
Type of output functions.
dimension_type id() const
Returns the index of the Cartesian axis associated to the variable.
static output_function_type * current_output_function
Pointer to the current output function.
bool less(Variable v, Variable w)
Defines a total ordering on variables.
A dimension of the vector space.
dimension_type space_dimension() const
Returns the dimension of the vector space enclosing *this.
bool operator()(Variable x, Variable y) const
Returns true if and only if x comes before y.
void m_swap(Variable &v)
Swaps *this and v.
memory_size_type total_memory_in_bytes() const
Returns the total size in bytes of the memory occupied by *this.
memory_size_type external_memory_in_bytes() const
Returns the size in bytes of the memory managed by *this.
The entire library is confined to this namespace.
Definition: version.hh:61
void swap(Variable &x, Variable &y)
size_t memory_size_type
An unsigned integral type for representing memory size in bytes.
static void set_output_function(output_function_type *p)
Sets the output function to be used for printing Variable objects.