$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
contract.hh
1 // Copyright (C) 2007, 2008, 2009, 2010 EPITA Research and Development
2 // Laboratory (LRDE)
3 //
4 // This file is part of Olena.
5 //
6 // Olena is free software: you can redistribute it and/or modify it under
7 // the terms of the GNU General Public License as published by the Free
8 // Software Foundation, version 2 of the License.
9 //
10 // Olena is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Olena. If not, see <http://www.gnu.org/licenses/>.
17 //
18 // As a special exception, you may use this file as part of a free
19 // software project without restriction. Specifically, if other files
20 // instantiate templates or use macros or inline functions from this
21 // file, or you compile this file and link it with other files to produce
22 // an executable, this file does not by itself cause the resulting
23 // executable to be covered by the GNU General Public License. This
24 // exception does not however invalidate any other reasons why the
25 // executable file might be covered by the GNU General Public License.
26 
27 #ifndef MLN_CORE_CONTRACT_HH
28 # define MLN_CORE_CONTRACT_HH
29 
33 
34 # include <cassert>
35 
36 // Define a preprocessor constant HAS_NDEBUG reflecting the existence
37 // of NDEBUG, as avised by the section Conditional Compilation of the
38 // GNU Coding Standards
39 // (http://www.gnu.org/prep/standards/html_node/Conditional-Compilation.html).
40 #ifdef NDEBUG
41 #define HAS_NDEBUG 1
42 #else
43 #define HAS_NDEBUG 0
44 #endif
45 
47 # define mln_assertion(expr) assert(static_cast<bool>(expr))
48 
50 # define mln_invariant(expr) assert(static_cast<bool>(expr))
51 
53 # define mln_precondition(expr) assert(static_cast<bool>(expr))
54 
56 # define mln_postcondition(expr) assert(static_cast<bool>(expr))
57 
58 
59 namespace mln
60 {
61 
63  bool implies(bool lexpr, bool rexpr);
64 
65 
66 # ifndef MLN_INCLUDE_ONLY
67 
68  inline
69  bool implies(bool lexpr, bool rexpr)
70  {
71  return (! lexpr) || rexpr;
72  }
73 
74 # endif // ! MLN_INCLUDE_ONLY
75 
76 } // end of namespace mln
77 
78 
79 #endif // ! MLN_CORE_CONTRACT_HH