aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen/src/Geometry
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2015-06-24 18:02:33 +0200
committerGravatar Gael Guennebaud <g.gael@free.fr>2015-06-24 18:02:33 +0200
commitc38c1953218bdf8aebdeedd43c75407670bb0973 (patch)
tree00ea6b8e71c223966004b5c9051e5fac8b61bb93 /Eigen/src/Geometry
parent23535ed31c6e59136ec16f6c3ea7ba1357016cde (diff)
Document how cross behaves on complex numbers
Diffstat (limited to 'Eigen/src/Geometry')
-rw-r--r--Eigen/src/Geometry/OrthoMethods.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/Eigen/src/Geometry/OrthoMethods.h b/Eigen/src/Geometry/OrthoMethods.h
index 6b2e57392..39b64b869 100644
--- a/Eigen/src/Geometry/OrthoMethods.h
+++ b/Eigen/src/Geometry/OrthoMethods.h
@@ -18,6 +18,10 @@ namespace Eigen {
* \returns the cross product of \c *this and \a other
*
* 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()
*/
template<typename Derived>