Merge of itasc branch. Project files, scons and cmake should be working. Makefile...
[blender.git] / extern / Eigen2 / Eigen / src / Core / CwiseNullaryOp.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) 2008 Gael Guennebaud <g.gael@free.fr>
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_CWISE_NULLARY_OP_H
26 #define EIGEN_CWISE_NULLARY_OP_H
27
28 /** \class CwiseNullaryOp
29   *
30   * \brief Generic expression of a matrix where all coefficients are defined by a functor
31   *
32   * \param NullaryOp template functor implementing the operator
33   *
34   * This class represents an expression of a generic nullary operator.
35   * It is the return type of the Ones(), Zero(), Constant(), Identity() and Random() functions,
36   * and most of the time this is the only way it is used.
37   *
38   * However, if you want to write a function returning such an expression, you
39   * will need to use this class.
40   *
41   * \sa class CwiseUnaryOp, class CwiseBinaryOp, MatrixBase::NullaryExpr()
42   */
43 template<typename NullaryOp, typename MatrixType>
44 struct ei_traits<CwiseNullaryOp<NullaryOp, MatrixType> > : ei_traits<MatrixType>
45 {
46   enum {
47     Flags = (ei_traits<MatrixType>::Flags
48       & (  HereditaryBits
49          | (ei_functor_has_linear_access<NullaryOp>::ret ? LinearAccessBit : 0)
50          | (ei_functor_traits<NullaryOp>::PacketAccess ? PacketAccessBit : 0)))
51       | (ei_functor_traits<NullaryOp>::IsRepeatable ? 0 : EvalBeforeNestingBit),
52     CoeffReadCost = ei_functor_traits<NullaryOp>::Cost
53   };
54 };
55
56 template<typename NullaryOp, typename MatrixType>
57 class CwiseNullaryOp : ei_no_assignment_operator,
58   public MatrixBase<CwiseNullaryOp<NullaryOp, MatrixType> >
59 {
60   public:
61
62     EIGEN_GENERIC_PUBLIC_INTERFACE(CwiseNullaryOp)
63
64     CwiseNullaryOp(int rows, int cols, const NullaryOp& func = NullaryOp())
65       : m_rows(rows), m_cols(cols), m_functor(func)
66     {
67       ei_assert(rows > 0
68           && (RowsAtCompileTime == Dynamic || RowsAtCompileTime == rows)
69           && cols > 0
70           && (ColsAtCompileTime == Dynamic || ColsAtCompileTime == cols));
71     }
72
73     EIGEN_STRONG_INLINE int rows() const { return m_rows.value(); }
74     EIGEN_STRONG_INLINE int cols() const { return m_cols.value(); }
75
76     EIGEN_STRONG_INLINE const Scalar coeff(int rows, int cols) const
77     {
78       return m_functor(rows, cols);
79     }
80
81     template<int LoadMode>
82     EIGEN_STRONG_INLINE PacketScalar packet(int, int) const
83     {
84       return m_functor.packetOp();
85     }
86
87     EIGEN_STRONG_INLINE const Scalar coeff(int index) const
88     {
89       if(RowsAtCompileTime == 1)
90         return m_functor(0, index);
91       else
92         return m_functor(index, 0);
93     }
94
95     template<int LoadMode>
96     EIGEN_STRONG_INLINE PacketScalar packet(int) const
97     {
98       return m_functor.packetOp();
99     }
100
101   protected:
102     const ei_int_if_dynamic<RowsAtCompileTime> m_rows;
103     const ei_int_if_dynamic<ColsAtCompileTime> m_cols;
104     const NullaryOp m_functor;
105 };
106
107
108 /** \returns an expression of a matrix defined by a custom functor \a func
109   *
110   * The parameters \a rows and \a cols are the number of rows and of columns of
111   * the returned matrix. Must be compatible with this MatrixBase type.
112   *
113   * This variant is meant to be used for dynamic-size matrix types. For fixed-size types,
114   * it is redundant to pass \a rows and \a cols as arguments, so Zero() should be used
115   * instead.
116   *
117   * The template parameter \a CustomNullaryOp is the type of the functor.
118   *
119   * \sa class CwiseNullaryOp
120   */
121 template<typename Derived>
122 template<typename CustomNullaryOp>
123 EIGEN_STRONG_INLINE const CwiseNullaryOp<CustomNullaryOp, Derived>
124 MatrixBase<Derived>::NullaryExpr(int rows, int cols, const CustomNullaryOp& func)
125 {
126   return CwiseNullaryOp<CustomNullaryOp, Derived>(rows, cols, func);
127 }
128
129 /** \returns an expression of a matrix defined by a custom functor \a func
130   *
131   * The parameter \a size is the size of the returned vector.
132   * Must be compatible with this MatrixBase type.
133   *
134   * \only_for_vectors
135   *
136   * This variant is meant to be used for dynamic-size vector types. For fixed-size types,
137   * it is redundant to pass \a size as argument, so Zero() should be used
138   * instead.
139   *
140   * The template parameter \a CustomNullaryOp is the type of the functor.
141   *
142   * \sa class CwiseNullaryOp
143   */
144 template<typename Derived>
145 template<typename CustomNullaryOp>
146 EIGEN_STRONG_INLINE const CwiseNullaryOp<CustomNullaryOp, Derived>
147 MatrixBase<Derived>::NullaryExpr(int size, const CustomNullaryOp& func)
148 {
149   EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
150   ei_assert(IsVectorAtCompileTime);
151   if(RowsAtCompileTime == 1) return CwiseNullaryOp<CustomNullaryOp, Derived>(1, size, func);
152   else return CwiseNullaryOp<CustomNullaryOp, Derived>(size, 1, func);
153 }
154
155 /** \returns an expression of a matrix defined by a custom functor \a func
156   *
157   * This variant is only for fixed-size MatrixBase types. For dynamic-size types, you
158   * need to use the variants taking size arguments.
159   *
160   * The template parameter \a CustomNullaryOp is the type of the functor.
161   *
162   * \sa class CwiseNullaryOp
163   */
164 template<typename Derived>
165 template<typename CustomNullaryOp>
166 EIGEN_STRONG_INLINE const CwiseNullaryOp<CustomNullaryOp, Derived>
167 MatrixBase<Derived>::NullaryExpr(const CustomNullaryOp& func)
168 {
169   return CwiseNullaryOp<CustomNullaryOp, Derived>(RowsAtCompileTime, ColsAtCompileTime, func);
170 }
171
172 /** \returns an expression of a constant matrix of value \a value
173   *
174   * The parameters \a rows and \a cols are the number of rows and of columns of
175   * the returned matrix. Must be compatible with this MatrixBase type.
176   *
177   * This variant is meant to be used for dynamic-size matrix types. For fixed-size types,
178   * it is redundant to pass \a rows and \a cols as arguments, so Zero() should be used
179   * instead.
180   *
181   * The template parameter \a CustomNullaryOp is the type of the functor.
182   *
183   * \sa class CwiseNullaryOp
184   */
185 template<typename Derived>
186 EIGEN_STRONG_INLINE const typename MatrixBase<Derived>::ConstantReturnType
187 MatrixBase<Derived>::Constant(int rows, int cols, const Scalar& value)
188 {
189   return NullaryExpr(rows, cols, ei_scalar_constant_op<Scalar>(value));
190 }
191
192 /** \returns an expression of a constant matrix of value \a value
193   *
194   * The parameter \a size is the size of the returned vector.
195   * Must be compatible with this MatrixBase type.
196   *
197   * \only_for_vectors
198   *
199   * This variant is meant to be used for dynamic-size vector types. For fixed-size types,
200   * it is redundant to pass \a size as argument, so Zero() should be used
201   * instead.
202   *
203   * The template parameter \a CustomNullaryOp is the type of the functor.
204   *
205   * \sa class CwiseNullaryOp
206   */
207 template<typename Derived>
208 EIGEN_STRONG_INLINE const typename MatrixBase<Derived>::ConstantReturnType
209 MatrixBase<Derived>::Constant(int size, const Scalar& value)
210 {
211   return NullaryExpr(size, ei_scalar_constant_op<Scalar>(value));
212 }
213
214 /** \returns an expression of a constant matrix of value \a value
215   *
216   * This variant is only for fixed-size MatrixBase types. For dynamic-size types, you
217   * need to use the variants taking size arguments.
218   *
219   * The template parameter \a CustomNullaryOp is the type of the functor.
220   *
221   * \sa class CwiseNullaryOp
222   */
223 template<typename Derived>
224 EIGEN_STRONG_INLINE const typename MatrixBase<Derived>::ConstantReturnType
225 MatrixBase<Derived>::Constant(const Scalar& value)
226 {
227   EIGEN_STATIC_ASSERT_FIXED_SIZE(Derived)
228   return NullaryExpr(RowsAtCompileTime, ColsAtCompileTime, ei_scalar_constant_op<Scalar>(value));
229 }
230
231 /** \returns true if all coefficients in this matrix are approximately equal to \a value, to within precision \a prec */
232 template<typename Derived>
233 bool MatrixBase<Derived>::isApproxToConstant
234 (const Scalar& value, RealScalar prec) const
235 {
236   for(int j = 0; j < cols(); ++j)
237     for(int i = 0; i < rows(); ++i)
238       if(!ei_isApprox(coeff(i, j), value, prec))
239         return false;
240   return true;
241 }
242
243 /** This is just an alias for isApproxToConstant().
244   *
245   * \returns true if all coefficients in this matrix are approximately equal to \a value, to within precision \a prec */
246 template<typename Derived>
247 bool MatrixBase<Derived>::isConstant
248 (const Scalar& value, RealScalar prec) const
249 {
250   return isApproxToConstant(value, prec);
251 }
252
253 /** Alias for setConstant(): sets all coefficients in this expression to \a value.
254   *
255   * \sa setConstant(), Constant(), class CwiseNullaryOp
256   */
257 template<typename Derived>
258 EIGEN_STRONG_INLINE void MatrixBase<Derived>::fill(const Scalar& value)
259 {
260   setConstant(value);
261 }
262
263 /** Sets all coefficients in this expression to \a value.
264   *
265   * \sa fill(), setConstant(int,const Scalar&), setConstant(int,int,const Scalar&), setZero(), setOnes(), Constant(), class CwiseNullaryOp, setZero(), setOnes()
266   */
267 template<typename Derived>
268 EIGEN_STRONG_INLINE Derived& MatrixBase<Derived>::setConstant(const Scalar& value)
269 {
270   return derived() = Constant(rows(), cols(), value);
271 }
272
273 /** Resizes to the given \a size, and sets all coefficients in this expression to the given \a value.
274   *
275   * \only_for_vectors
276   *
277   * Example: \include Matrix_set_int.cpp
278   * Output: \verbinclude Matrix_setConstant_int.out
279   *
280   * \sa MatrixBase::setConstant(const Scalar&), setConstant(int,int,const Scalar&), class CwiseNullaryOp, MatrixBase::Constant(const Scalar&)
281   */
282 template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
283 EIGEN_STRONG_INLINE Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>&
284 Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>::setConstant(int size, const Scalar& value)
285 {
286   resize(size);
287   return setConstant(value);
288 }
289
290 /** Resizes to the given size, and sets all coefficients in this expression to the given \a value.
291   *
292   * \param rows the new number of rows
293   * \param cols the new number of columns
294   *
295   * Example: \include Matrix_setConstant_int_int.cpp
296   * Output: \verbinclude Matrix_setConstant_int_int.out
297   *
298   * \sa MatrixBase::setConstant(const Scalar&), setConstant(int,const Scalar&), class CwiseNullaryOp, MatrixBase::Constant(const Scalar&)
299   */
300 template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
301 EIGEN_STRONG_INLINE Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>&
302 Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>::setConstant(int rows, int cols, const Scalar& value)
303 {
304   resize(rows, cols);
305   return setConstant(value);
306 }
307
308
309 // zero:
310
311 /** \returns an expression of a zero matrix.
312   *
313   * The parameters \a rows and \a cols are the number of rows and of columns of
314   * the returned matrix. Must be compatible with this MatrixBase type.
315   *
316   * This variant is meant to be used for dynamic-size matrix types. For fixed-size types,
317   * it is redundant to pass \a rows and \a cols as arguments, so Zero() should be used
318   * instead.
319   *
320   * \addexample Zero \label How to take get a zero matrix
321   *
322   * Example: \include MatrixBase_zero_int_int.cpp
323   * Output: \verbinclude MatrixBase_zero_int_int.out
324   *
325   * \sa Zero(), Zero(int)
326   */
327 template<typename Derived>
328 EIGEN_STRONG_INLINE const typename MatrixBase<Derived>::ConstantReturnType
329 MatrixBase<Derived>::Zero(int rows, int cols)
330 {
331   return Constant(rows, cols, Scalar(0));
332 }
333
334 /** \returns an expression of a zero vector.
335   *
336   * The parameter \a size is the size of the returned vector.
337   * Must be compatible with this MatrixBase type.
338   *
339   * \only_for_vectors
340   *
341   * This variant is meant to be used for dynamic-size vector types. For fixed-size types,
342   * it is redundant to pass \a size as argument, so Zero() should be used
343   * instead.
344   *
345   * Example: \include MatrixBase_zero_int.cpp
346   * Output: \verbinclude MatrixBase_zero_int.out
347   *
348   * \sa Zero(), Zero(int,int)
349   */
350 template<typename Derived>
351 EIGEN_STRONG_INLINE const typename MatrixBase<Derived>::ConstantReturnType
352 MatrixBase<Derived>::Zero(int size)
353 {
354   return Constant(size, Scalar(0));
355 }
356
357 /** \returns an expression of a fixed-size zero matrix or vector.
358   *
359   * This variant is only for fixed-size MatrixBase types. For dynamic-size types, you
360   * need to use the variants taking size arguments.
361   *
362   * Example: \include MatrixBase_zero.cpp
363   * Output: \verbinclude MatrixBase_zero.out
364   *
365   * \sa Zero(int), Zero(int,int)
366   */
367 template<typename Derived>
368 EIGEN_STRONG_INLINE const typename MatrixBase<Derived>::ConstantReturnType
369 MatrixBase<Derived>::Zero()
370 {
371   return Constant(Scalar(0));
372 }
373
374 /** \returns true if *this is approximately equal to the zero matrix,
375   *          within the precision given by \a prec.
376   *
377   * Example: \include MatrixBase_isZero.cpp
378   * Output: \verbinclude MatrixBase_isZero.out
379   *
380   * \sa class CwiseNullaryOp, Zero()
381   */
382 template<typename Derived>
383 bool MatrixBase<Derived>::isZero(RealScalar prec) const
384 {
385   for(int j = 0; j < cols(); ++j)
386     for(int i = 0; i < rows(); ++i)
387       if(!ei_isMuchSmallerThan(coeff(i, j), static_cast<Scalar>(1), prec))
388         return false;
389   return true;
390 }
391
392 /** Sets all coefficients in this expression to zero.
393   *
394   * Example: \include MatrixBase_setZero.cpp
395   * Output: \verbinclude MatrixBase_setZero.out
396   *
397   * \sa class CwiseNullaryOp, Zero()
398   */
399 template<typename Derived>
400 EIGEN_STRONG_INLINE Derived& MatrixBase<Derived>::setZero()
401 {
402   return setConstant(Scalar(0));
403 }
404
405 /** Resizes to the given \a size, and sets all coefficients in this expression to zero.
406   *
407   * \only_for_vectors
408   *
409   * Example: \include Matrix_setZero_int.cpp
410   * Output: \verbinclude Matrix_setZero_int.out
411   *
412   * \sa MatrixBase::setZero(), setZero(int,int), class CwiseNullaryOp, MatrixBase::Zero()
413   */
414 template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
415 EIGEN_STRONG_INLINE Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>&
416 Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>::setZero(int size)
417 {
418   resize(size);
419   return setConstant(Scalar(0));
420 }
421
422 /** Resizes to the given size, and sets all coefficients in this expression to zero.
423   *
424   * \param rows the new number of rows
425   * \param cols the new number of columns
426   *
427   * Example: \include Matrix_setZero_int_int.cpp
428   * Output: \verbinclude Matrix_setZero_int_int.out
429   *
430   * \sa MatrixBase::setZero(), setZero(int), class CwiseNullaryOp, MatrixBase::Zero()
431   */
432 template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
433 EIGEN_STRONG_INLINE Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>&
434 Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>::setZero(int rows, int cols)
435 {
436   resize(rows, cols);
437   return setConstant(Scalar(0));
438 }
439
440 // ones:
441
442 /** \returns an expression of a matrix where all coefficients equal one.
443   *
444   * The parameters \a rows and \a cols are the number of rows and of columns of
445   * the returned matrix. Must be compatible with this MatrixBase type.
446   *
447   * This variant is meant to be used for dynamic-size matrix types. For fixed-size types,
448   * it is redundant to pass \a rows and \a cols as arguments, so Ones() should be used
449   * instead.
450   *
451   * \addexample One \label How to get a matrix with all coefficients equal one
452   *
453   * Example: \include MatrixBase_ones_int_int.cpp
454   * Output: \verbinclude MatrixBase_ones_int_int.out
455   *
456   * \sa Ones(), Ones(int), isOnes(), class Ones
457   */
458 template<typename Derived>
459 EIGEN_STRONG_INLINE const typename MatrixBase<Derived>::ConstantReturnType
460 MatrixBase<Derived>::Ones(int rows, int cols)
461 {
462   return Constant(rows, cols, Scalar(1));
463 }
464
465 /** \returns an expression of a vector where all coefficients equal one.
466   *
467   * The parameter \a size is the size of the returned vector.
468   * Must be compatible with this MatrixBase type.
469   *
470   * \only_for_vectors
471   *
472   * This variant is meant to be used for dynamic-size vector types. For fixed-size types,
473   * it is redundant to pass \a size as argument, so Ones() should be used
474   * instead.
475   *
476   * Example: \include MatrixBase_ones_int.cpp
477   * Output: \verbinclude MatrixBase_ones_int.out
478   *
479   * \sa Ones(), Ones(int,int), isOnes(), class Ones
480   */
481 template<typename Derived>
482 EIGEN_STRONG_INLINE const typename MatrixBase<Derived>::ConstantReturnType
483 MatrixBase<Derived>::Ones(int size)
484 {
485   return Constant(size, Scalar(1));
486 }
487
488 /** \returns an expression of a fixed-size matrix or vector where all coefficients equal one.
489   *
490   * This variant is only for fixed-size MatrixBase types. For dynamic-size types, you
491   * need to use the variants taking size arguments.
492   *
493   * Example: \include MatrixBase_ones.cpp
494   * Output: \verbinclude MatrixBase_ones.out
495   *
496   * \sa Ones(int), Ones(int,int), isOnes(), class Ones
497   */
498 template<typename Derived>
499 EIGEN_STRONG_INLINE const typename MatrixBase<Derived>::ConstantReturnType
500 MatrixBase<Derived>::Ones()
501 {
502   return Constant(Scalar(1));
503 }
504
505 /** \returns true if *this is approximately equal to the matrix where all coefficients
506   *          are equal to 1, within the precision given by \a prec.
507   *
508   * Example: \include MatrixBase_isOnes.cpp
509   * Output: \verbinclude MatrixBase_isOnes.out
510   *
511   * \sa class CwiseNullaryOp, Ones()
512   */
513 template<typename Derived>
514 bool MatrixBase<Derived>::isOnes
515 (RealScalar prec) const
516 {
517   return isApproxToConstant(Scalar(1), prec);
518 }
519
520 /** Sets all coefficients in this expression to one.
521   *
522   * Example: \include MatrixBase_setOnes.cpp
523   * Output: \verbinclude MatrixBase_setOnes.out
524   *
525   * \sa class CwiseNullaryOp, Ones()
526   */
527 template<typename Derived>
528 EIGEN_STRONG_INLINE Derived& MatrixBase<Derived>::setOnes()
529 {
530   return setConstant(Scalar(1));
531 }
532
533 /** Resizes to the given \a size, and sets all coefficients in this expression to one.
534   *
535   * \only_for_vectors
536   *
537   * Example: \include Matrix_setOnes_int.cpp
538   * Output: \verbinclude Matrix_setOnes_int.out
539   *
540   * \sa MatrixBase::setOnes(), setOnes(int,int), class CwiseNullaryOp, MatrixBase::Ones()
541   */
542 template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
543 EIGEN_STRONG_INLINE Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>&
544 Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>::setOnes(int size)
545 {
546   resize(size);
547   return setConstant(Scalar(1));
548 }
549
550 /** Resizes to the given size, and sets all coefficients in this expression to one.
551   *
552   * \param rows the new number of rows
553   * \param cols the new number of columns
554   *
555   * Example: \include Matrix_setOnes_int_int.cpp
556   * Output: \verbinclude Matrix_setOnes_int_int.out
557   *
558   * \sa MatrixBase::setOnes(), setOnes(int), class CwiseNullaryOp, MatrixBase::Ones()
559   */
560 template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
561 EIGEN_STRONG_INLINE Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>&
562 Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>::setOnes(int rows, int cols)
563 {
564   resize(rows, cols);
565   return setConstant(Scalar(1));
566 }
567
568 // Identity:
569
570 /** \returns an expression of the identity matrix (not necessarily square).
571   *
572   * The parameters \a rows and \a cols are the number of rows and of columns of
573   * the returned matrix. Must be compatible with this MatrixBase type.
574   *
575   * This variant is meant to be used for dynamic-size matrix types. For fixed-size types,
576   * it is redundant to pass \a rows and \a cols as arguments, so Identity() should be used
577   * instead.
578   *
579   * \addexample Identity \label How to get an identity matrix
580   *
581   * Example: \include MatrixBase_identity_int_int.cpp
582   * Output: \verbinclude MatrixBase_identity_int_int.out
583   *
584   * \sa Identity(), setIdentity(), isIdentity()
585   */
586 template<typename Derived>
587 EIGEN_STRONG_INLINE const typename MatrixBase<Derived>::IdentityReturnType
588 MatrixBase<Derived>::Identity(int rows, int cols)
589 {
590   return NullaryExpr(rows, cols, ei_scalar_identity_op<Scalar>());
591 }
592
593 /** \returns an expression of the identity matrix (not necessarily square).
594   *
595   * This variant is only for fixed-size MatrixBase types. For dynamic-size types, you
596   * need to use the variant taking size arguments.
597   *
598   * Example: \include MatrixBase_identity.cpp
599   * Output: \verbinclude MatrixBase_identity.out
600   *
601   * \sa Identity(int,int), setIdentity(), isIdentity()
602   */
603 template<typename Derived>
604 EIGEN_STRONG_INLINE const typename MatrixBase<Derived>::IdentityReturnType
605 MatrixBase<Derived>::Identity()
606 {
607   EIGEN_STATIC_ASSERT_FIXED_SIZE(Derived)
608   return NullaryExpr(RowsAtCompileTime, ColsAtCompileTime, ei_scalar_identity_op<Scalar>());
609 }
610
611 /** \returns true if *this is approximately equal to the identity matrix
612   *          (not necessarily square),
613   *          within the precision given by \a prec.
614   *
615   * Example: \include MatrixBase_isIdentity.cpp
616   * Output: \verbinclude MatrixBase_isIdentity.out
617   *
618   * \sa class CwiseNullaryOp, Identity(), Identity(int,int), setIdentity()
619   */
620 template<typename Derived>
621 bool MatrixBase<Derived>::isIdentity
622 (RealScalar prec) const
623 {
624   for(int j = 0; j < cols(); ++j)
625   {
626     for(int i = 0; i < rows(); ++i)
627     {
628       if(i == j)
629       {
630         if(!ei_isApprox(coeff(i, j), static_cast<Scalar>(1), prec))
631           return false;
632       }
633       else
634       {
635         if(!ei_isMuchSmallerThan(coeff(i, j), static_cast<RealScalar>(1), prec))
636           return false;
637       }
638     }
639   }
640   return true;
641 }
642
643 template<typename Derived, bool Big = (Derived::SizeAtCompileTime>=16)>
644 struct ei_setIdentity_impl
645 {
646   static EIGEN_STRONG_INLINE Derived& run(Derived& m)
647   {
648     return m = Derived::Identity(m.rows(), m.cols());
649   }
650 };
651
652 template<typename Derived>
653 struct ei_setIdentity_impl<Derived, true>
654 {
655   static EIGEN_STRONG_INLINE Derived& run(Derived& m)
656   {
657     m.setZero();
658     const int size = std::min(m.rows(), m.cols());
659     for(int i = 0; i < size; ++i) m.coeffRef(i,i) = typename Derived::Scalar(1);
660     return m;
661   }
662 };
663
664 /** Writes the identity expression (not necessarily square) into *this.
665   *
666   * Example: \include MatrixBase_setIdentity.cpp
667   * Output: \verbinclude MatrixBase_setIdentity.out
668   *
669   * \sa class CwiseNullaryOp, Identity(), Identity(int,int), isIdentity()
670   */
671 template<typename Derived>
672 EIGEN_STRONG_INLINE Derived& MatrixBase<Derived>::setIdentity()
673 {
674   return ei_setIdentity_impl<Derived>::run(derived());
675 }
676
677 /** Resizes to the given size, and writes the identity expression (not necessarily square) into *this.
678   *
679   * \param rows the new number of rows
680   * \param cols the new number of columns
681   *
682   * Example: \include Matrix_setIdentity_int_int.cpp
683   * Output: \verbinclude Matrix_setIdentity_int_int.out
684   *
685   * \sa MatrixBase::setIdentity(), class CwiseNullaryOp, MatrixBase::Identity()
686   */
687 template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
688 EIGEN_STRONG_INLINE Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>&
689 Matrix<_Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols>::setIdentity(int rows, int cols)
690 {
691   resize(rows, cols);
692   return setIdentity();
693 }
694
695 /** \returns an expression of the i-th unit (basis) vector.
696   *
697   * \only_for_vectors
698   *
699   * \sa MatrixBase::Unit(int), MatrixBase::UnitX(), MatrixBase::UnitY(), MatrixBase::UnitZ(), MatrixBase::UnitW()
700   */
701 template<typename Derived>
702 EIGEN_STRONG_INLINE const typename MatrixBase<Derived>::BasisReturnType MatrixBase<Derived>::Unit(int size, int i)
703 {
704   EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
705   return BasisReturnType(SquareMatrixType::Identity(size,size), i);
706 }
707
708 /** \returns an expression of the i-th unit (basis) vector.
709   *
710   * \only_for_vectors
711   *
712   * This variant is for fixed-size vector only.
713   *
714   * \sa MatrixBase::Unit(int,int), MatrixBase::UnitX(), MatrixBase::UnitY(), MatrixBase::UnitZ(), MatrixBase::UnitW()
715   */
716 template<typename Derived>
717 EIGEN_STRONG_INLINE const typename MatrixBase<Derived>::BasisReturnType MatrixBase<Derived>::Unit(int i)
718 {
719   EIGEN_STATIC_ASSERT_VECTOR_ONLY(Derived)
720   return BasisReturnType(SquareMatrixType::Identity(),i);
721 }
722
723 /** \returns an expression of the X axis unit vector (1{,0}^*)
724   *
725   * \only_for_vectors
726   *
727   * \sa MatrixBase::Unit(int,int), MatrixBase::Unit(int), MatrixBase::UnitY(), MatrixBase::UnitZ(), MatrixBase::UnitW()
728   */
729 template<typename Derived>
730 EIGEN_STRONG_INLINE const typename MatrixBase<Derived>::BasisReturnType MatrixBase<Derived>::UnitX()
731 { return Derived::Unit(0); }
732
733 /** \returns an expression of the Y axis unit vector (0,1{,0}^*)
734   *
735   * \only_for_vectors
736   *
737   * \sa MatrixBase::Unit(int,int), MatrixBase::Unit(int), MatrixBase::UnitY(), MatrixBase::UnitZ(), MatrixBase::UnitW()
738   */
739 template<typename Derived>
740 EIGEN_STRONG_INLINE const typename MatrixBase<Derived>::BasisReturnType MatrixBase<Derived>::UnitY()
741 { return Derived::Unit(1); }
742
743 /** \returns an expression of the Z axis unit vector (0,0,1{,0}^*)
744   *
745   * \only_for_vectors
746   *
747   * \sa MatrixBase::Unit(int,int), MatrixBase::Unit(int), MatrixBase::UnitY(), MatrixBase::UnitZ(), MatrixBase::UnitW()
748   */
749 template<typename Derived>
750 EIGEN_STRONG_INLINE const typename MatrixBase<Derived>::BasisReturnType MatrixBase<Derived>::UnitZ()
751 { return Derived::Unit(2); }
752
753 /** \returns an expression of the W axis unit vector (0,0,0,1)
754   *
755   * \only_for_vectors
756   *
757   * \sa MatrixBase::Unit(int,int), MatrixBase::Unit(int), MatrixBase::UnitY(), MatrixBase::UnitZ(), MatrixBase::UnitW()
758   */
759 template<typename Derived>
760 EIGEN_STRONG_INLINE const typename MatrixBase<Derived>::BasisReturnType MatrixBase<Derived>::UnitW()
761 { return Derived::Unit(3); }
762
763 #endif // EIGEN_CWISE_NULLARY_OP_H