aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/CustomizingEigen_NullaryExpr.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/CustomizingEigen_NullaryExpr.dox
parent1e2ab8b0b33782cacf7effbf77d41decb35939f2 (diff)
Doc: add links and discourage user to write their own expression (better use CwiseNullaryOp)
Diffstat (limited to 'doc/CustomizingEigen_NullaryExpr.dox')
-rw-r--r--doc/CustomizingEigen_NullaryExpr.dox5
1 files changed, 3 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