Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
math/sign.hh
1 // Copyright (C) 2007, 2009 EPITA Research and Development Laboratory (LRDE)
2 //
3 // This file is part of Olena.
4 //
5 // Olena is free software: you can redistribute it and/or modify it under
6 // the terms of the GNU General Public License as published by the Free
7 // Software Foundation, version 2 of the License.
8 //
9 // Olena is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 // General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Olena. If not, see <http://www.gnu.org/licenses/>.
16 //
17 // As a special exception, you may use this file as part of a free
18 // software project without restriction. Specifically, if other files
19 // instantiate templates or use macros or inline functions from this
20 // file, or you compile this file and link it with other files to produce
21 // an executable, this file does not by itself cause the resulting
22 // executable to be covered by the GNU General Public License. This
23 // exception does not however invalidate any other reasons why the
24 // executable file might be covered by the GNU General Public License.
25 
26 #ifndef MLN_MATH_SIGN_HH
27 # define MLN_MATH_SIGN_HH
28 
35 namespace mln
36 {
37 
38  namespace math
39  {
40 
41  enum sign_t
42  {
43  negative = -1,
44  null = 0,
45  positive = +1
46  };
47 
48 
49  template <typename T>
50  sign_t sign(const T& v);
51 
52 
53 # ifndef MLN_INCLUDE_ONLY
54 
55  template <typename T>
56  inline
57  sign_t sign(const T& v)
58  {
59  return v > 0 ? positive : (v < 0 ? negative : null);
60  }
61 
62 # endif // ! MLN_INCLUDE_ONLY
63 
64  } // end of namespace mln::math
65 
66 } // end of namespace mln
67 
68 
69 #endif // ! MLN_MATH_SIGN_HH