diff options
| author |  Gael Guennebaud <g.gael@free.fr> | 2016-08-30 15:57:46 +0200 |
|---|---|---|
| committer | Gael Guennebaud <g.gael@free.fr> | 2016-08-30 15:57:46 +0200 |
| commit | e7fbbc2748dac4addbc429e053ead795968d86c6 (patch) | |
| tree | 18ab1a17d6da5c47e97933bbfef20a1ba59281c9 /doc | |
| parent | 1e2ab8b0b33782cacf7effbf77d41decb35939f2 (diff) | |
Doc: add links and discourage user to write their own expression (better use CwiseNullaryOp)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/CustomizingEigen_NullaryExpr.dox | 5 | ||||
| -rw-r--r-- | doc/NewExpressionType.dox | 6 |
2 files changed, 9 insertions, 2 deletions
diff --git a/doc/CustomizingEigen_NullaryExpr.dox b/doc/CustomizingEigen_NullaryExpr.dox index 9352c3d73..cefa5317c 100644 --- a/doc/CustomizingEigen_NullaryExpr.dox +++ b/doc/CustomizingEigen_NullaryExpr.dox @@ -1,11 +1,12 @@ namespace Eigen { -/** \page TopicCustomizing_NullaryExpr Manipulate matrices through nullary-expression +/** \page TopicCustomizing_NullaryExpr Matrix manipulation via nullary-expressions + The main purpose of the class CwiseNullaryOp is to define \em procedural matrices such as constant or random matrices as returned by the Ones(), Zero(), Constant(), Identity() and Random() methods. Nevertheless, with some imagination it is possible to accomplish very sophisticated matrix manipulation with minimal efforts such that \ref TopicNewExpressionType "implementing new expression" is rarely needed. -\section NullaryExpr_Circulant +\section NullaryExpr_Circulant Example 1: circulant matrix To explore these possibilities let us start with the \em circulant example of the \ref TopicNewExpressionType "implementing new expression" topic. Let us recall that a circulant matrix is a matrix where each column is the same as the 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 |