Commit Graph

866 Commits

Author SHA1 Message Date
Gael Guennebaud
475295b5ff Enable documentation of Array's typedefs 2019-02-20 15:18:07 +01:00
Gael Guennebaud
844e5447f8 Update documentation regarding alignment issue. 2019-02-20 13:54:04 +01:00
Gael Guennebaud
e3622a0396 Slightly extend discussions on auto and move the content of the Pit falls wiki page here.
http://eigen.tuxfamily.org/index.php?title=Pit_Falls
2019-01-30 13:09:21 +01:00
Gael Guennebaud
ec8a387972 cleanup 2019-01-24 10:24:45 +01:00
David Tellenbach
237b03b372 PR 574: use variadic template instead of initializer_list to implement fixed-size vector ctor from coefficients. 2019-01-23 00:07:19 +01:00
Christoph Hertzberg
bd6dadcda8 Tell doxygen that cxx11 math is available 2019-01-24 00:14:02 +01:00
Christoph Hertzberg
e16913a45f Fix name of tutorial snippet. 2019-01-23 10:35:06 +01:00
Gael Guennebaud
80f81f9c4b Cleanup SFINAE in Array/Matrix(initializer_list) ctors and minor doc editing. 2019-01-22 17:08:47 +01:00
David Tellenbach
db152b9ee6 PR 572: Add initializer list constructors to Matrix and Array (include unit tests and doc)
- {1,2,3,4,5,...} for fixed-size vectors only
- {{1,2,3},{4,5,6}} for the general cases
- {{1,2,3,4,5,....}} is allowed for both row and column-vector
2019-01-21 16:25:57 +01:00
Gael Guennebaud
7b35c26b1c Doc: remove link to porting guide 2019-01-17 10:35:50 +01:00
Gael Guennebaud
4759d9e86d Doc: add manual page on STL iterators 2019-01-17 10:35:14 +01:00
Gael Guennebaud
ce88e297dc Add a comment stating this doc page is partly obsolete. 2019-01-16 16:29:02 +01:00
Gael Guennebaud
729d1291c2 bug #1585: update doc on lazy-evaluation 2019-01-16 16:28:17 +01:00
Gael Guennebaud
c8e40edac9 Remove Eigen2ToEigen3 migration page (obsolete since 3.3) 2019-01-16 16:27:00 +01:00
Rasmus Munk Larsen
ec7fe83554 Merge. 2019-01-14 13:26:58 -08:00
Rasmus Munk Larsen
2c5843dbbb Update documentation. 2019-01-14 13:26:34 -08:00
Gael Guennebaud
efa4c9c40f bug #1615: slightly increase the default unrolling limit to compensate for changeset 101ea26f5e
.
This solves a performance regression with clang and 3x3 matrix products.
2018-12-13 10:42:39 +01:00
Gael Guennebaud
acc3459a49 Add help messages in the quick ref/ascii docs regarding slicing, indexing, and reshaping. 2018-12-05 17:17:23 +01:00
Gael Guennebaud
e2e897298a Fix page nesting 2018-12-05 17:13:46 +01:00
Christoph Hertzberg
806352d844 Small typo found be Patrick Huber (pull request PR-547) 2018-11-23 12:34:27 +00:00
Gael Guennebaud
4263f23c28 Improve doc on multi-threading and warn about hyper-threading 2018-11-14 14:42:29 +01:00
Gael Guennebaud
db529ae4ec doxygen does not like \addtogroup and \ingroup in the same line 2018-11-14 14:42:06 +01:00
luz.paz"
f67b19a884 [PATCH 1/2] Misc. typos
From 68d431b4c14ad60a778ee93c1f59ecc4b931950e Mon Sep 17 00:00:00 2001
Found via `codespell -q 3 -I ../eigen-word-whitelist.txt` where the whitelists consists of:
```
als
ans
cas
dum
lastr
lowd
nd
overfl
pres
preverse
substraction
te
uint
whch
```
---
 CMakeLists.txt                                | 26 +++++++++----------
 Eigen/src/Core/GenericPacketMath.h            |  2 +-
 Eigen/src/SparseLU/SparseLU.h                 |  2 +-
 bench/bench_norm.cpp                          |  2 +-
 doc/HiPerformance.dox                         |  2 +-
 doc/QuickStartGuide.dox                       |  2 +-
 .../Eigen/CXX11/src/Tensor/TensorChipping.h   |  6 ++---
 .../Eigen/CXX11/src/Tensor/TensorDeviceGpu.h  |  2 +-
 .../src/Tensor/TensorForwardDeclarations.h    |  4 +--
 .../src/Tensor/TensorGpuHipCudaDefines.h      |  2 +-
 .../Eigen/CXX11/src/Tensor/TensorReduction.h  |  2 +-
 .../CXX11/src/Tensor/TensorReductionGpu.h     |  2 +-
 .../test/cxx11_tensor_concatenation.cpp       |  2 +-
 unsupported/test/cxx11_tensor_executor.cpp    |  2 +-
 14 files changed, 29 insertions(+), 29 deletions(-)
2018-09-18 04:15:01 -04:00
Gael Guennebaud
c81bdbdadc Add manual doc on STL-compatible iterators 2018-11-12 22:06:33 +01:00
Gael Guennebaud
fbd6e7b025 add missing ref to a.zeta(b) 2018-11-09 13:53:42 +01:00
Gael Guennebaud
dffd1e11de Limit the size of the toc 2018-11-09 13:52:34 +01:00
Gael Guennebaud
a88e0a0e95 Update doxy hacks wrt doxygen 1.8.13/14 2018-11-09 13:52:10 +01:00
Gael Guennebaud
d7c644213c Add and update manual pages for slicing, indexing, and reshaping. 2018-11-09 11:35:27 +01:00
Halie Murray-Davis
fb62d6d96e Fix typo in tutorial documentation. 2018-10-25 04:55:34 +00:00
Christoph Hertzberg
b5f077d22c Document EIGEN_NO_IO preprocessor directive 2018-10-25 16:49:25 +02:00
Christoph Hertzberg
449ff74672 Fix most Doxygen warnings. Also add links to stable documentation from unsupported modules (by using the corresponding Doxytags file).
Manually grafted from d107a371c6
2018-10-19 21:10:28 +02:00
Gael Guennebaud
1dcf5a6ed8 fix typo in doc 2018-10-17 09:29:36 +02:00
Gael Guennebaud
aa5820056e Unify c++11 usage in doc's examples and snippets 2018-10-08 17:32:54 +02:00
Gael Guennebaud
d92f004ab7 Simplify API by removing allCols/allRows and reusing rowwise/colwise to define iterators over rows/columns 2018-10-05 23:11:21 +02:00
Gael Guennebaud
91613bf2c2 Add support for c++11 snippets 2018-10-05 23:08:39 +02:00
Gael Guennebaud
5f26f57598 Change the logic of A.reshaped<Order>() to be a simple alias to A.reshaped<Order>(AutoSize,fix<1>).
This means that now AutoOrder is allowed, and it always return a column-vector.
2018-10-03 11:41:47 +02:00
Gael Guennebaud
41c3a2ffc1 Fix documentation of reshape to vectors. 2018-09-25 16:35:44 +02:00
Gael Guennebaud
a488d59787 merge with default Eigen 2018-09-21 11:51:49 +02:00
Gael Guennebaud
0c56d22e2e Fix shadowing 2018-09-20 22:56:21 +02:00
Gael Guennebaud
c3a19527a2 Fix doc wrt previous change 2018-09-19 11:49:26 +02:00
luz.paz"
43fd42a33b Fix doxy and misc. typos
Found via `codespell -q 3 -I ../eigen-word-whitelist.txt`
---
 Eigen/src/Core/ProductEvaluators.h |  4 ++--
 Eigen/src/Core/arch/GPU/Half.h     |  2 +-
 Eigen/src/Core/util/Memory.h       |  2 +-
 Eigen/src/Geometry/Hyperplane.h    |  2 +-
 Eigen/src/Geometry/Transform.h     |  2 +-
 Eigen/src/Geometry/Translation.h   | 12 ++++++------
 doc/PreprocessorDirectives.dox     |  2 +-
 doc/TutorialGeometry.dox           |  2 +-
 test/boostmultiprec.cpp            |  2 +-
 test/triangular.cpp                |  2 +-
 10 files changed, 16 insertions(+), 16 deletions(-)
2018-08-01 21:34:47 -04:00
Christoph Hertzberg
4b1ad086b5 Fix shadow warnings in doc-snippets 2018-08-25 10:07:17 +02:00
Patrik Huber
f5cace5e9f Fix two small typos in the documentation 2018-07-26 19:55:19 +00:00
Christoph Hertzberg
5e79402b4a fix warnings for doc-eigen-prerequisites 2018-07-24 21:59:15 +02:00
Gael Guennebaud
c25034710e Fiw some warnings in dox examples 2018-06-07 16:09:22 +02:00
Gael Guennebaud
c723ffd763 Fix warning 2018-06-07 15:56:20 +02:00
Gael Guennebaud
6af1433cb5 Doc: add aliasing in common pitfaffs. 2018-05-29 22:37:47 +02:00
Gael Guennebaud
79266fec75 extend doxygen splitter for huge screens 2018-04-11 11:31:17 +02:00
Gael Guennebaud
426052ef6e Update header/footer for doxygen 1.8.13 2018-04-11 11:30:34 +02:00
Gael Guennebaud
9c8decffbf Fix javascript hacks for oxygen 1.8.13 2018-04-11 11:30:14 +02:00
Gael Guennebaud
e798466871 bug #1538: update manual pages regarding BDCSVD. 2018-04-11 10:46:11 +02:00
luz.paz
e3912f5e63 MIsc. source and comment typos
Found using `codespell` and `grep` from downstream FreeCAD
2018-03-11 10:01:44 -04:00
Benoit Steiner
746a6b7b81 Merged in zzp11/eigen/zzp11/a-small-mistake-quickreferencedox-edited-1510217281963 (pull request PR-346)
a small mistake QuickReference.dox edited online with Bitbucket
2018-03-23 01:02:34 +00:00
Gael Guennebaud
546ab97d76 Add possibility to overwrite EIGEN_STRONG_INLINE. 2017-12-14 14:47:38 +01:00
zhouzhaoping
912e9965ef a small mistake QuickReference.dox edited online with Bitbucket 2017-11-09 08:49:01 +00:00
Gael Guennebaud
39864ebe1e bug #336: improve doc for PlainObjectBase::Map 2017-08-22 17:18:43 +02:00
Gael Guennebaud
9deee79922 bug #1457: add setUnit() methods for consistency. 2017-08-22 16:48:07 +02:00
Gael Guennebaud
103c0aa6ad Add KLU in the list of third-party sparse solvers 2017-11-10 14:13:29 +01:00
Gael Guennebaud
f86bb89d39 Add EIGEN_MKL_NO_DIRECT_CALL option 2017-11-09 11:07:45 +01:00
Gael Guennebaud
5c68ba41a8 typos 2017-02-21 17:10:55 +01:00
Gael Guennebaud
d29e9d7119 Improve documentation of reshaped 2017-02-21 17:03:10 +01:00
Gael Guennebaud
83d6a529c3 Use Eigen::fix<N> to pass compile-time sizes. 2017-02-11 15:31:28 +01:00
Gael Guennebaud
24409f3acd Use fix<> API to specify compile-time reshaped sizes. 2017-01-29 15:20:35 +01:00
Gael Guennebaud
0e89baa5d8 import yoco xiao's work on reshape 2017-01-29 14:29:31 +01:00
Gael Guennebaud
59801a3250 Add \newin{3.x} doxygen command 2017-01-17 10:31:28 +01:00
Gael Guennebaud
43c617e2ee merge 2017-01-11 14:33:37 +01:00
Gael Guennebaud
152cd57bb7 Enable generation of doc for static variables in Eigen's namespace. 2017-01-11 14:29:20 +01:00
Gael Guennebaud
45199b9773 Fix typo 2017-01-11 09:34:08 +01:00
Gael Guennebaud
2810ba194b Clarify MKL_DIRECT_CALL doc. 2017-08-17 22:12:26 +02:00
Gael Guennebaud
8c858bd891 Clarify doc regarding the usage of MKL_DIRECT_CALL 2017-08-17 12:17:45 +02:00
Gael Guennebaud
a74b9ba7cd Update documentation for CUDA 2017-07-17 11:05:26 +02:00
Gael Guennebaud
50e09cca0f fix tipo 2017-06-11 15:30:36 +02:00
Gael Guennebaud
2299717fd5 Fix and workaround several doxygen issues/warnings 2017-01-04 23:27:33 +01:00
Gael Guennebaud
5165de97a4 Add missing snippet files. 2017-01-04 23:08:27 +01:00
Gael Guennebaud
a5ebc92f8d bug #1336: fix doxygen issue regarding EIGEN_CWISE_BINARY_RETURN_TYPE 2017-01-04 18:21:44 +01:00
Marco Falke
4ebf69394d doc: Fix trivial typo in AsciiQuickReference.txt
* * *
fixup!
2017-01-01 13:25:48 +00:00
Gael Guennebaud
57acb05eef Update and extend doc on alignment issues. 2016-12-11 22:45:32 +01:00
Gael Guennebaud
f725f1cebc Mention the CMAKE_PREFIX_PATH variable. 2016-12-06 15:23:45 +01:00
Gael Guennebaud
0c4d05b009 Explain how to choose your favorite Eigen version 2016-12-06 11:34:06 +01:00
Sergiu Deitsch
3440b46e2f doc: mention the NO_MODULE option and target availability
(grafted from 65f09be8d2
)
2016-11-30 15:41:38 +01:00
Sergiu Deitsch
5c516e4e0a cmake: added Eigen3::Eigen imported target
(grafted from a287140f72
)
2016-11-22 12:25:06 +01:00
Gael Guennebaud
21d0286d81 bug #1348: Document EIGEN_MAX_ALIGN_BYTES and EIGEN_MAX_STATIC_ALIGN_BYTES,
and reflect in the doc that EIGEN_DONT_ALIGN* are deprecated.
2016-11-23 22:15:03 +01:00
Gael Guennebaud
53c77061f0 bug #698: rewrite LinSpaced for integer scalar types to avoid overflow and guarantee an even spacing when possible.
Otherwise, the "high" bound is implicitly lowered to the largest value allowing for an even distribution.
This changeset also disable vectorization for this integer path.
2016-10-24 15:50:27 +02:00
Gael Guennebaud
b9f7a17e47 Add missing file. 2016-09-23 10:26:08 +02:00
Gael Guennebaud
9bcdc8b756 Add a nullary-functor example performing index-based sub-matrices. 2016-09-22 22:27:54 +02:00
Gael Guennebaud
ca7f061a5f bug #828: clarify documentation of SparseMatrixBase's methods returning a sub-matrix. 2016-09-16 11:23:19 +02:00
Gael Guennebaud
50e203c717 bug #828: clarify documentation of SparseMatrixBase's unary methods. 2016-09-16 10:40:50 +02:00
Gael Guennebaud
7ae819123c Simplify CwiseNullaryOp example. 2016-08-31 15:46:04 +02:00
Gael Guennebaud
e7fbbc2748 Doc: add links and discourage user to write their own expression (better use CwiseNullaryOp) 2016-08-30 15:57:46 +02:00
Gael Guennebaud
1e2ab8b0b3 Doc: add an exemple showing how custom expression can be advantageously implemented via CwiseNullaryOp. 2016-08-30 15:40:41 +02:00
Gael Guennebaud
9c9e23858e Doc: split customizing-eigen page into sub-pages and re-structure a bit the different topics 2016-08-30 11:10:08 +02:00
Gael Guennebaud
1f84f0d33a merge EulerAngles module 2016-08-30 10:01:53 +02:00
Gael Guennebaud
7e029d1d6e bug #1271: add SparseMatrix::coeffs() methods returning a 1D view of the non zero coefficients. 2016-08-29 12:06:37 +02:00
Christoph Hertzberg
9636a8ed43 bug #1273: Add parentheses when redefining eigen_assert 2016-08-12 15:34:21 +02:00
Gael Guennebaud
819d0cea1b List PARDISO solver. 2016-08-02 23:32:41 +02:00
Gael Guennebaud
188590db82 Add instructions for LAPACKE+Accelerate 2016-07-27 15:07:35 +02:00
Gael Guennebaud
9d16b6e1cf Formatting 2016-07-26 23:51:43 +02:00
Gael Guennebaud
429028b652 Typo. 2016-07-26 12:12:53 +02:00
Gael Guennebaud
6b89fa802c Typos. 2016-07-26 12:08:04 +02:00
Gael Guennebaud
8021aed89e Split BLAS/LAPACK versus MKL documentation 2016-07-26 11:11:59 +02:00