soc-2008-mxcurioni: merged changes to revision 23516
[blender.git] / extern / Eigen2 / Eigen / src / Core / IO.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 // Copyright (C) 2008 Gael Guennebaud <g.gael@free.fr>
6 //
7 // Eigen is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU Lesser General Public
9 // License as published by the Free Software Foundation; either
10 // version 3 of the License, or (at your option) any later version.
11 //
12 // Alternatively, you can redistribute it and/or
13 // modify it under the terms of the GNU General Public License as
14 // published by the Free Software Foundation; either version 2 of
15 // the License, or (at your option) any later version.
16 //
17 // Eigen is distributed in the hope that it will be useful, but WITHOUT ANY
18 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
19 // FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the
20 // GNU General Public License for more details.
21 //
22 // You should have received a copy of the GNU Lesser General Public
23 // License and a copy of the GNU General Public License along with
24 // Eigen. If not, see <http://www.gnu.org/licenses/>.
25
26 #ifndef EIGEN_IO_H
27 #define EIGEN_IO_H
28
29 enum { Raw, AlignCols };
30
31 /** \class IOFormat
32   *
33   * \brief Stores a set of parameters controlling the way matrices are printed
34   *
35   * List of available parameters:
36   *  - \b precision number of digits for floating point values
37   *  - \b flags can be either Raw (default) or AlignCols which aligns all the columns
38   *  - \b coeffSeparator string printed between two coefficients of the same row
39   *  - \b rowSeparator string printed between two rows
40   *  - \b rowPrefix string printed at the beginning of each row
41   *  - \b rowSuffix string printed at the end of each row
42   *  - \b matPrefix string printed at the beginning of the matrix
43   *  - \b matSuffix string printed at the end of the matrix
44   *
45   * Example: \include IOFormat.cpp
46   * Output: \verbinclude IOFormat.out
47   *
48   * \sa MatrixBase::format(), class WithFormat
49   */
50 struct IOFormat
51 {
52   /** Default contructor, see class IOFormat for the meaning of the parameters */
53   IOFormat(int _precision=4, int _flags=Raw,
54     const std::string& _coeffSeparator = " ",
55     const std::string& _rowSeparator = "\n", const std::string& _rowPrefix="", const std::string& _rowSuffix="",
56     const std::string& _matPrefix="", const std::string& _matSuffix="")
57   : matPrefix(_matPrefix), matSuffix(_matSuffix), rowPrefix(_rowPrefix), rowSuffix(_rowSuffix), rowSeparator(_rowSeparator),
58     coeffSeparator(_coeffSeparator), precision(_precision), flags(_flags)
59   {
60     rowSpacer = "";
61     int i = int(matSuffix.length())-1;
62     while (i>=0 && matSuffix[i]!='\n')
63     {
64       rowSpacer += ' ';
65       i--;
66     }
67   }
68   std::string matPrefix, matSuffix;
69   std::string rowPrefix, rowSuffix, rowSeparator, rowSpacer;
70   std::string coeffSeparator;
71   int precision;
72   int flags;
73 };
74
75 /** \class WithFormat
76   *
77   * \brief Pseudo expression providing matrix output with given format
78   *
79   * \param ExpressionType the type of the object on which IO stream operations are performed
80   *
81   * This class represents an expression with stream operators controlled by a given IOFormat.
82   * It is the return type of MatrixBase::format()
83   * and most of the time this is the only way it is used.
84   *
85   * See class IOFormat for some examples.
86   *
87   * \sa MatrixBase::format(), class IOFormat
88   */
89 template<typename ExpressionType>
90 class WithFormat
91 {
92   public:
93
94     WithFormat(const ExpressionType& matrix, const IOFormat& format)
95       : m_matrix(matrix), m_format(format)
96     {}
97
98     friend std::ostream & operator << (std::ostream & s, const WithFormat& wf)
99     {
100       return ei_print_matrix(s, wf.m_matrix.eval(), wf.m_format);
101     }
102
103   protected:
104     const typename ExpressionType::Nested m_matrix;
105     IOFormat m_format;
106 };
107
108 /** \returns a WithFormat proxy object allowing to print a matrix the with given
109   * format \a fmt.
110   *
111   * See class IOFormat for some examples.
112   *
113   * \sa class IOFormat, class WithFormat
114   */
115 template<typename Derived>
116 inline const WithFormat<Derived>
117 MatrixBase<Derived>::format(const IOFormat& fmt) const
118 {
119   return WithFormat<Derived>(derived(), fmt);
120 }
121
122 /** \internal
123   * print the matrix \a _m to the output stream \a s using the output format \a fmt */
124 template<typename Derived>
125 std::ostream & ei_print_matrix(std::ostream & s, const Derived& _m, const IOFormat& fmt)
126 {
127   const typename Derived::Nested m = _m;
128
129   int width = 0;
130   if (fmt.flags & AlignCols)
131   {
132     // compute the largest width
133     for(int j = 1; j < m.cols(); ++j)
134       for(int i = 0; i < m.rows(); ++i)
135       {
136         std::stringstream sstr;
137         sstr.precision(fmt.precision);
138         sstr << m.coeff(i,j);
139         width = std::max<int>(width, int(sstr.str().length()));
140       }
141   }
142   s.precision(fmt.precision);
143   s << fmt.matPrefix;
144   for(int i = 0; i < m.rows(); ++i)
145   {
146     if (i)
147       s << fmt.rowSpacer;
148     s << fmt.rowPrefix;
149     if(width) s.width(width);
150     s << m.coeff(i, 0);
151     for(int j = 1; j < m.cols(); ++j)
152     {
153       s << fmt.coeffSeparator;
154       if (width) s.width(width);
155       s << m.coeff(i, j);
156     }
157     s << fmt.rowSuffix;
158     if( i < m.rows() - 1)
159       s << fmt.rowSeparator;
160   }
161   s << fmt.matSuffix;
162   return s;
163 }
164
165 /** \relates MatrixBase
166   *
167   * Outputs the matrix, to the given stream.
168   *
169   * If you wish to print the matrix with a format different than the default, use MatrixBase::format().
170   *
171   * It is also possible to change the default format by defining EIGEN_DEFAULT_IO_FORMAT before including Eigen headers.
172   * If not defined, this will automatically be defined to Eigen::IOFormat(), that is the Eigen::IOFormat with default parameters.
173   *
174   * \sa MatrixBase::format()
175   */
176 template<typename Derived>
177 std::ostream & operator <<
178 (std::ostream & s,
179  const MatrixBase<Derived> & m)
180 {
181   return ei_print_matrix(s, m.eval(), EIGEN_DEFAULT_IO_FORMAT);
182 }
183
184 #endif // EIGEN_IO_H