Document how cross behaves on complex numbers

This commit is contained in:
Gael Guennebaud 2015-06-24 18:02:33 +02:00
parent 23535ed31c
commit c38c195321

View File

@ -18,6 +18,10 @@ namespace Eigen {
* \returns the cross product of \c *this and \a other * \returns the cross product of \c *this and \a other
* *
* Here is a very good explanation of cross-product: http://xkcd.com/199/ * Here is a very good explanation of cross-product: http://xkcd.com/199/
*
* With complex numbers, the cross product is implemented as
* \f$ (\mathbf{a}+i\mathbf{b}) \times (\mathbf{c}+i\mathbf{d}) = (\mathbf{a} \times \mathbf{c} - \mathbf{b} \times \mathbf{d}) - i(\mathbf{a} \times \mathbf{d} - \mathbf{b} \times \mathbf{c})\f$
*
* \sa MatrixBase::cross3() * \sa MatrixBase::cross3()
*/ */
template<typename Derived> template<typename Derived>