mirror/eigen
2
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2024-12-27 07:29:52 +08:00
Code Issues Packages Projects Releases Wiki Activity
9882aec279
eigen/doc
History
Antonio Sanchez 5dac0b53c9 Move Eigen::all,last,lastp1,lastN to Eigen::placeholders::. 
These names are so common, IMO they should not exist directly in the
`Eigen::` namespace.  This prevents us from using the `last` or `all`
names for any parameters or local variables, otherwise spitting out
warnings about shadowing or hiding the global values.  Many external
projects (and our own examples) also heavily use
```
using namespace Eigen;
```
which means these conflict with external libraries as well, e.g.
`std::fill(first,last,value)`.

It seems originally these were placed in a separate namespace
`Eigen::placeholders`, which has since been deprecated.  I propose
to un-deprecate this, and restore the original locations.

These symbols are also imported into `Eigen::indexing`, which
additionally imports `fix` and `seq`. An alternative is to remove the
`placeholders` namespace and stick with `indexing`.

NOTE: this is an API-breaking change.

Fixes #2321.
2021-09-17 10:21:42 -07:00
..
examples Bump CMake files to at least c++11. 2021-08-25 20:07:48 +00:00
snippets Bump CMake files to at least c++11. 2021-08-25 20:07:48 +00:00
special_examples Bump CMake files to at least c++11. 2021-08-25 20:07:48 +00:00
AsciiQuickReference.txt Add help messages in the quick ref/ascii docs regarding slicing, indexing, and reshaping. 2018-12-05 17:17:23 +01:00
B01_Experimental.dox
ClassHierarchy.dox
CMakeLists.txt Bump CMake files to at least c++11. 2021-08-25 20:07:48 +00:00
CoeffwiseMathFunctionsTable.dox Add MatrixBase::cwiseArg() 2020-10-14 01:56:42 +00:00
CustomizingEigen_CustomScalar.dox digits10() needs to return an integer 2019-05-31 15:45:41 +02:00
CustomizingEigen_InheritingMatrix.dox Doc: split customizing-eigen page into sub-pages and re-structure a bit the different topics 2016-08-30 11:10:08 +02:00
CustomizingEigen_NullaryExpr.dox Add a nullary-functor example performing index-based sub-matrices. 2016-09-22 22:27:54 +02:00
CustomizingEigen_Plugins.dox Doc: split customizing-eigen page into sub-pages and re-structure a bit the different topics 2016-08-30 11:10:08 +02:00
DenseDecompositionBenchmark.dox Update old links to bitbucket to point to gitlab.com 2019-12-04 10:57:07 +01:00
Doxyfile.in Workaround for doxygen class template titles in which the template 2020-11-27 19:52:16 -07:00
eigen_navtree_hacks.js Add missing footer declaration 2020-07-24 10:28:44 +02:00
Eigen_Silly_Professor_64x64.png
eigendoxy_footer.html.in remove piwik tracker 2020-07-23 13:51:39 +02:00
eigendoxy_header.html.in add a banner to advertise the survey 2020-07-29 19:01:38 +02:00
eigendoxy_layout.xml.in
eigendoxy_tabs.css
eigendoxy.css Make file formatting comply with POSIX and Unix standards 2020-03-23 18:09:02 +00:00
FixedSizeVectorizable.dox Update and extend doc on alignment issues. 2016-12-11 22:45:32 +01:00
ftv2node.png Add some doxygen's images to support both old and recent doxygen versions 2016-07-12 16:45:43 +02:00
ftv2pnode.png Add some doxygen's images to support both old and recent doxygen versions 2016-07-12 16:45:43 +02:00
FunctionsTakingEigenTypes.dox Fix two small typos in the documentation 2018-07-26 19:55:19 +00:00
HiPerformance.dox [PATCH 1/2] Misc. typos 2018-09-18 04:15:01 -04:00
InplaceDecomposition.dox Typo. 2016-07-26 12:12:53 +02:00
InsideEigenExample.dox Avoid leading underscore followed by cap in template identifiers 2021-08-04 22:41:52 +00:00
LeastSquares.dox Update documentation for matrix decompositions and least squares solvers. 2021-08-16 21:56:18 +00:00
Manual.dox Remove Eigen2ToEigen3 migration page (obsolete since 3.3) 2019-01-16 16:27:00 +01:00
MatrixfreeSolverExample.dox Formatting 2016-07-26 23:51:43 +02:00
NewExpressionType.dox Doc: add links and discourage user to write their own expression (better use CwiseNullaryOp) 2016-08-30 15:57:46 +02:00
Overview.dox Doc: remove link to porting guide 2019-01-17 10:35:50 +01:00
PassingByValue.dox Update and extend doc on alignment issues. 2016-12-11 22:45:32 +01:00
Pitfalls.dox Document possible inconsistencies when using Matrix<bool, ...> 2021-02-17 00:50:26 +01:00
PreprocessorDirectives.dox Possibility to specify user-defined default cache sizes for GEBP kernel 2020-05-08 12:54:36 +02:00
QuickReference.dox Document that using raw function pointers doesn't work with unaryExpr. 2021-02-27 22:58:42 +01:00
QuickStartGuide.dox Put code in monospace (typewriter) style. 2021-08-03 01:48:32 +00:00
SparseLinearSystems.dox Put code in monospace (typewriter) style. 2021-08-03 01:48:32 +00:00
SparseQuickReference.dox Put code in monospace (typewriter) style. 2021-08-03 01:48:32 +00:00
StlContainers.dox Escape \# inside doxygen docu 2019-07-12 19:45:13 +02:00
StorageOrders.dox
StructHavingEigenMembers.dox Update documentation regarding alignment issue. 2019-02-20 13:54:04 +01:00
TemplateKeyword.dox MIsc. source and comment typos 2018-03-11 10:01:44 -04:00
TopicAliasing.dox
TopicAssertions.dox bug #1273: Add parentheses when redefining eigen_assert 2016-08-12 15:34:21 +02:00
TopicCMakeGuide.dox Mention the CMAKE_PREFIX_PATH variable. 2016-12-06 15:23:45 +01:00
TopicEigenExpressionTemplates.dox
TopicLazyEvaluation.dox bug #1585: update doc on lazy-evaluation 2019-01-16 16:28:17 +01:00
TopicLinearAlgebraDecompositions.dox Update documentation for matrix decompositions and least squares solvers. 2021-08-16 21:56:18 +00:00
TopicMultithreading.dox Mention problems when using potentially throwing scalars and OpenMP 2020-10-09 17:04:25 +02:00
TopicResizing.dox
TopicScalarTypes.dox
TopicVectorization.dox
tutorial.cpp
TutorialAdvancedInitialization.dox
TutorialArrayClass.dox
TutorialBlockOperations.dox updated documentation for middleCol and middleRow 2021-08-05 17:21:16 +00:00
TutorialGeometry.dox Added leading asterisk for Doxygen to consume as it was removing asterisk intended to be part of the code. 2019-07-18 18:12:14 +00:00
TutorialLinearAlgebra.dox Update documentation for matrix decompositions and least squares solvers. 2021-08-16 21:56:18 +00:00
TutorialMapClass.dox MIsc. source and comment typos 2018-03-11 10:01:44 -04:00
TutorialMatrixArithmetic.dox
TutorialMatrixClass.dox Put code in monospace (typewriter) style. 2021-08-03 01:48:32 +00:00
TutorialReductionsVisitorsBroadcasting.dox
TutorialReshape.dox Put code in monospace (typewriter) style. 2021-08-03 01:48:32 +00:00
TutorialSlicingIndexing.dox Move Eigen::all,last,lastp1,lastN to Eigen::placeholders::. 2021-09-17 10:21:42 -07:00
TutorialSparse_example_details.dox
TutorialSparse.dox Put code in monospace (typewriter) style. 2021-08-03 01:48:32 +00:00
TutorialSTL.dox Fix name of tutorial snippet. 2019-01-23 10:35:06 +01:00
UnalignedArrayAssert.dox Update documentation regarding alignment issue. 2019-02-20 13:54:04 +01:00
UsingBlasLapackBackends.dox Add instructions for LAPACKE+Accelerate 2016-07-27 15:07:35 +02:00
UsingIntelMKL.dox Add EIGEN_MKL_NO_DIRECT_CALL option 2017-11-09 11:07:45 +01:00
UsingNVCC.dox MIsc. source and comment typos 2018-03-11 10:01:44 -04:00
WrongStackAlignment.dox