Cycles: svn merge -r41225:41232 ^/trunk/blender
[blender.git] / extern / Eigen2 / Eigen / src / Core / NumTraits.h
1 // This file is part of Eigen, a lightweight C++ template library
2 // for linear algebra. Eigen itself is part of the KDE project.
3 //
4 // Copyright (C) 2006-2008 Benoit Jacob <jacob.benoit.1@gmail.com>
5 //
6 // Eigen is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 3 of the License, or (at your option) any later version.
10 //
11 // Alternatively, you can redistribute it and/or
12 // modify it under the terms of the GNU General Public License as
13 // published by the Free Software Foundation; either version 2 of
14 // the License, or (at your option) any later version.
15 //
16 // Eigen is distributed in the hope that it will be useful, but WITHOUT ANY
17 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the
19 // GNU General Public License for more details.
20 //
21 // You should have received a copy of the GNU Lesser General Public
22 // License and a copy of the GNU General Public License along with
23 // Eigen. If not, see <http://www.gnu.org/licenses/>.
24
25 #ifndef EIGEN_NUMTRAITS_H
26 #define EIGEN_NUMTRAITS_H
27
28 /** \class NumTraits
29   *
30   * \brief Holds some data about the various numeric (i.e. scalar) types allowed by Eigen.
31   *
32   * \param T the numeric type about which this class provides data. Recall that Eigen allows
33   *          only the following types for \a T: \c int, \c float, \c double,
34   *          \c std::complex<float>, \c std::complex<double>, and \c long \c double (especially
35   *          useful to enforce x87 arithmetics when SSE is the default).
36   *
37   * The provided data consists of:
38   * \li A typedef \a Real, giving the "real part" type of \a T. If \a T is already real,
39   *     then \a Real is just a typedef to \a T. If \a T is \c std::complex<U> then \a Real
40   *     is a typedef to \a U.
41   * \li A typedef \a FloatingPoint, giving the "floating-point type" of \a T. If \a T is
42   *     \c int, then \a FloatingPoint is a typedef to \c double. Otherwise, \a FloatingPoint
43   *     is a typedef to \a T.
44   * \li An enum value \a IsComplex. It is equal to 1 if \a T is a \c std::complex
45   *     type, and to 0 otherwise.
46   * \li An enum \a HasFloatingPoint. It is equal to \c 0 if \a T is \c int,
47   *     and to \c 1 otherwise.
48   */
49 template<typename T> struct NumTraits;
50
51 template<> struct NumTraits<int>
52 {
53   typedef int Real;
54   typedef double FloatingPoint;
55   enum {
56     IsComplex = 0,
57     HasFloatingPoint = 0,
58     ReadCost = 1,
59     AddCost = 1,
60     MulCost = 1
61   };
62 };
63
64 template<> struct NumTraits<float>
65 {
66   typedef float Real;
67   typedef float FloatingPoint;
68   enum {
69     IsComplex = 0,
70     HasFloatingPoint = 1,
71     ReadCost = 1,
72     AddCost = 1,
73     MulCost = 1
74   };
75 };
76
77 template<> struct NumTraits<double>
78 {
79   typedef double Real;
80   typedef double FloatingPoint;
81   enum {
82     IsComplex = 0,
83     HasFloatingPoint = 1,
84     ReadCost = 1,
85     AddCost = 1,
86     MulCost = 1
87   };
88 };
89
90 template<typename _Real> struct NumTraits<std::complex<_Real> >
91 {
92   typedef _Real Real;
93   typedef std::complex<_Real> FloatingPoint;
94   enum {
95     IsComplex = 1,
96     HasFloatingPoint = NumTraits<Real>::HasFloatingPoint,
97     ReadCost = 2,
98     AddCost = 2 * NumTraits<Real>::AddCost,
99     MulCost = 4 * NumTraits<Real>::MulCost + 2 * NumTraits<Real>::AddCost
100   };
101 };
102
103 template<> struct NumTraits<long long int>
104 {
105   typedef long long int Real;
106   typedef long double FloatingPoint;
107   enum {
108     IsComplex = 0,
109     HasFloatingPoint = 0,
110     ReadCost = 1,
111     AddCost = 1,
112     MulCost = 1
113   };
114 };
115
116 template<> struct NumTraits<long double>
117 {
118   typedef long double Real;
119   typedef long double FloatingPoint;
120   enum {
121     IsComplex = 0,
122     HasFloatingPoint = 1,
123     ReadCost = 1,
124     AddCost = 1,
125     MulCost = 1
126   };
127 };
128
129 template<> struct NumTraits<bool>
130 {
131   typedef bool Real;
132   typedef float FloatingPoint;
133   enum {
134     IsComplex = 0,
135     HasFloatingPoint = 0,
136     ReadCost = 1,
137     AddCost = 1,
138     MulCost = 1
139   };
140 };
141
142 #endif // EIGEN_NUMTRAITS_H