aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/NewExpressionType.dox
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2016-08-30 15:57:46 +0200
committerGravatar Gael Guennebaud <g.gael@free.fr>2016-08-30 15:57:46 +0200
commite7fbbc2748dac4addbc429e053ead795968d86c6 (patch)
tree18ab1a17d6da5c47e97933bbfef20a1ba59281c9 /doc/NewExpressionType.dox
parent1e2ab8b0b33782cacf7effbf77d41decb35939f2 (diff)
Doc: add links and discourage user to write their own expression (better use CwiseNullaryOp)
Diffstat (limited to 'doc/NewExpressionType.dox')
-rw-r--r--doc/NewExpressionType.dox6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/NewExpressionType.dox b/doc/NewExpressionType.dox
index c2e78bfee..c2f243312 100644
--- a/doc/NewExpressionType.dox
+++ b/doc/NewExpressionType.dox
@@ -2,6 +2,12 @@ namespace Eigen {
/** \page TopicNewExpressionType Adding a new expression type
+<!--<span style="font-size:130%; color:red; font-weight: 900;"></span>-->
+\warning
+Disclaimer: this page is tailored to very advanced users who are not afraid of dealing with some %Eigen's internal aspects.
+In most cases, a custom expression can be avoided by either using custom \ref MatrixBase::unaryExpr "unary" or \ref MatrixBase::binaryExpr "binary" functors,
+while extremely complex matrix manipulations can be achieved by a nullary functors as described in the \ref TopicCustomizing_NullaryExpr "previous page".
+
This page describes with the help of an example how to implement a new
light-weight expression type in %Eigen. This consists of three parts:
the expression type itself, a traits class containing compile-time