Commit Graph

857 Commits

Author SHA1 Message Date
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
Gael Guennebaud
c9425492c8 Update doc. 2016-07-25 18:41:26 +02:00
Gael Guennebaud
e1c7c5968a Update doc. 2016-07-25 11:18:04 +02:00
Gael Guennebaud
007edee1ac Add a doc page summarizing the true speed of Eigen's decompositions. 2016-07-21 12:32:02 +02:00
Gael Guennebaud
fd057f86b3 Complete the coeff-wise math function table. 2016-07-20 12:14:10 +02:00
Gael Guennebaud
9ab35d8ba4 Fix compilation of doc 2016-07-12 16:47:39 +02:00
Gael Guennebaud
19614497ae Add some doxygen's images to support both old and recent doxygen versions
(with some vague definitions of old and recent ;) )
2016-07-12 16:45:43 +02:00
Gael Guennebaud
bec35f4c55 Clarify that SpecialFunctions is unsupported 2016-07-11 18:38:40 +02:00
Gael Guennebaud
2f7e2614e7 bug #1232: refactor special functions as a new SpecialFunctions module, currently in unsupported/. 2016-07-08 11:13:55 +02:00
Gael Guennebaud
7f7839c12f Add documentation and exemples for inplace decomposition. 2016-07-04 17:18:26 +02:00
Tal Hadad
8e198d6835 Complete docs and add ostream operator for EulerAngles. 2016-06-19 20:42:45 +03:00
Gael Guennebaud
a9bb653a68 Update doc (scalar_add_op is now deprecated) 2016-06-14 12:07:00 +02:00
Gael Guennebaud
cd221a62ee Doc: start of a table summarizing coefficient-wise math functions. 2016-06-01 17:09:48 +02:00
Gael Guennebaud
afd33539dd Doc: makes the global unary math functions visible to doxygen (and docuement them) 2016-06-01 15:27:13 +02:00
Gael Guennebaud
77e652d8ad Doc: improve documentation of Map<SparseMatrix> 2016-06-01 10:03:32 +02:00
Gael Guennebaud
da4970ead2 Doc: disable inlining of inherited members, workaround Doxygen's limited C++ parsing abilities, and improve doc of MapBase. 2016-06-01 09:38:49 +02:00
Christoph Hertzberg
41dcd047d7 bug #1237: Redefine eigen_assert instead of disabling assertions for documentation snippets 2016-05-26 18:13:33 +02:00
Christoph Hertzberg
2ee306e44a Temporary workaround for bug #1237. The snippet (expectedly) failed with enabled assertions. 2016-05-26 16:16:41 +02:00
Gael Guennebaud
3f715e1701 update doc wrt to unaligned vectorization 2016-05-24 22:34:59 +02:00
Gael Guennebaud
9216abe28d Document EIGEN_UNALIGNED_VECTORIZE. 2016-05-24 22:14:34 +02:00
Gael Guennebaud
6a15e14cda Document EIGEN_MAX_CPP_VER and user controllable compiler features. 2016-05-20 15:26:09 +02:00
Gael Guennebaud
998f2efc58 Add a EIGEN_MAX_CPP_VER option to limit the C++ version to be used. 2016-05-20 14:44:28 +02:00
Gael Guennebaud
ce12562710 Add some c++11 flags in documentation 2016-05-19 17:35:30 +02:00
Gael Guennebaud
1744b5b5d2 Update doc regarding the genericity of EIGEN_USE_BLAS 2016-04-11 17:16:07 +02:00
Gael Guennebaud
fc6a0ebb1c Typos in doc. 2016-04-11 10:54:58 +02:00
Gael Guennebaud
8e1f1ba6a6 Import wiki's paragraph: "I disabled vectorization, but I'm still getting annoyed about alignment issues" 2016-02-12 22:16:59 +01:00
Gael Guennebaud
c8b4c4b48a bug #795: mention allocate_shared as a condidate for aligned_allocator. 2016-02-12 22:09:16 +01:00
Gael Guennebaud
6eff3e5185 Fix triangularView versus triangularPart. 2016-02-12 17:09:28 +01:00
Gael Guennebaud
010afe1619 Add exemples for reshaping/slicing with Map. 2016-02-06 22:49:18 +01:00
Gael Guennebaud
62a1c911cd Remove posix_memalign, _mm_malloc, and _aligned_malloc special paths. 2016-02-05 21:24:35 +01:00
Gael Guennebaud
c85fbfd0b7 Clarify documentation on the restrictions of writable sparse block expressions. 2016-02-03 16:08:43 +01:00
Gael Guennebaud
102fa96a96 Extend doc on dense+sparse 2016-01-30 14:58:21 +01:00
Gael Guennebaud
4865e1e732 Update link to suitesparse. 2016-01-27 22:48:40 +01:00
Gael Guennebaud
0f8d26c6a9 Doc: add flip* and arrayfun MatLab equivalent. 2016-01-26 23:34:48 +01:00
Gael Guennebaud
c10021c00a bug #1144: clarify the doc about aliasing in case of resizing and matrix product. 2016-01-25 15:50:55 +01:00
Lars Buitinck
19e437daf0 Copyedit documentation: typos, spelling 2016-01-24 15:50:36 +01:00
Gael Guennebaud
f9d71a1729 extend matlab conversion table 2016-01-08 22:24:45 +01:00
Gael Guennebaud
addb7066e8 Workaround "empty paragraph" warning with clang -Wdocumentation 2015-12-30 16:45:44 +01:00
Gael Guennebaud
29bb599e03 Fix numerous doxygen issues in auto-link generation 2015-12-30 16:04:24 +01:00
Gael Guennebaud
162ccb2938 Fix links to Eigen2-to-Eigen3 porting helpers 2015-12-30 16:03:14 +01:00
Gael Guennebaud
5fae3750b5 Recent versions of doxygen miss-parsed Eigen/* headers 2015-12-30 16:02:05 +01:00
Gael Guennebaud
b84cefe61d Add missing snippets for erf/erfc/lgamma functions. 2015-12-30 15:12:15 +01:00
Gael Guennebaud
16dd82ed51 Add missing snippet for sign/cwiseSign functions. 2015-12-30 15:11:42 +01:00
connor-k
95dd423cca [doc] Remove extra ';' in Tutorial_AdvancedInitialization_Join.cpp 2015-12-21 01:12:26 +00:00
Gael Guennebaud
82152f2ae6 bug #1132: add EIGEN_MAPBASE_PLUGIN 2015-12-11 11:43:49 +01:00
Gael Guennebaud
ad3d68400e Add matrix-free solver example 2015-12-07 12:33:38 +01:00
Gael Guennebaud
31b661e4ca Add a note on initParallel being optional in C++11. 2015-11-23 13:28:43 +01:00
Gael Guennebaud
05a0ee25df Fix warning. 2015-10-29 21:06:07 +01:00
Ilya Popov
1a842c0dc4 Fix typo in TutorialSparse: laplace equation contains gradient symbol (\nabla) instead of laplacian (\Delta). 2015-10-28 09:52:55 +00:00
Gael Guennebaud
2c516ba38f Remove auto references and referenced-by relation in doc. 2015-10-09 12:07:06 +02:00
Gael Guennebaud
5d7ebfb275 Update sparse solver list to make it more complete 2015-10-08 11:33:17 +02:00
Gael Guennebaud
64242b8bf3 Doc: add link to doc of sparse solver concept 2015-10-08 10:50:39 +02:00
Gael Guennebaud
02e940fc9f bug #1071: improve doc on lpNorm and add example for some operator norms 2015-09-28 11:55:36 +02:00
Gael Guennebaud
5bf971e5b8 MKL is now free of charge for opensource 2015-09-07 11:23:55 +02:00
Gael Guennebaud
73a86cfcd3 Add EIGEN_QUATERNION_PLUGIN 2015-09-07 11:12:30 +02:00
Gael Guennebaud
7fad309631 Fix link and code formating 2015-09-07 11:08:41 +02:00
Gael Guennebaud
d91db41a31 Fix documentation example 2015-09-03 14:14:14 +02:00
Gael Guennebaud
be5e2ecc21 bug #505: add more examples of bad and correct usages of auto and eval(). 2015-09-02 13:04:30 +02:00
Gael Guennebaud
aba8c9ee17 Add a documentation page for common pitfalls 2015-09-02 11:23:55 +02:00
ITimer
93635cafee Fixed a spelling error 2015-08-10 15:11:10 +08:00
Jonas Adler
815fa0dbf6 Fixed some compiler bugs in NVCC, now compiles with CUDA.
(chtz: Manually joined sevaral commits to keep the history clean)
2015-07-22 12:29:18 +02:00
Gael Guennebaud
ab8b497a7e Add pow(scalar,array) in quick ref 2015-07-20 13:59:21 +02:00
Gael Guennebaud
6544b49e59 Generalize pow(x,e) such that x and e can be a different expression type or a scalar for either x or e. Add x.pow(e) with e an array expression. 2015-07-20 13:57:55 +02:00
Gael Guennebaud
2d93060291 Fix trivial warnings. 2015-07-20 13:55:48 +02:00
Gael Guennebaud
555b9c6843 Doc: explain perf and multithreading issues in sparse iterative solvers 2015-06-26 10:49:40 +02:00
Gael Guennebaud
9c7cfa7dab Update list of main modules 2015-06-22 14:17:24 +02:00
Gael Guennebaud
3ccd23efc0 Update coeff-wise quick-reference doc. 2015-06-22 14:08:54 +02:00
Gael Guennebaud
e5b490b654 Fix isfinite/isinf/isnan code snippets 2015-06-15 15:09:25 +02:00
Gael Guennebaud
916ef52fff merge 2015-06-11 09:35:49 +02:00
Gael Guennebaud
25a98be948 bug #80: merge with d_hood branch on adding more coefficient-wise unary array functors 2015-06-10 15:52:05 +02:00
MattPD
447e060b81 [Doc] Fix wording / typos in TemplateKeyword.dox 2015-05-11 16:50:18 +00:00
Christoph Hertzberg
6273aca9b1 small typo 2015-05-04 15:26:31 +00:00
michiel van dyck
4b9eddaef8 [Doc] Multi-threading fix
OLD: n = Eigen::nbThreads( n );
NEW: n = Eigen::nbThreads( );

from:
You can query the number of threads that will be used with:
\code
n = Eigen::nbThreads( );
\endcode

Kr Michiel
2015-05-04 14:48:52 +00:00
Christoph Hertzberg
28a4c92cbf bug #998: Started fixing doxygen warnings 2015-05-01 22:10:41 +02:00
Christoph Hertzberg
173b34e9ab bug #999: clarify that behavior of empty AlignedBoxes is undefined, and further improvements in documentation 2015-04-30 19:30:36 +02:00
Gael Guennebaud
de18cd413d Disable posix_memalign on Solaris and SunOS, and allows to by-pass built-in posix_memalign detection rules. 2015-04-24 11:26:51 +02:00
Deanna Hood
0250f4a9f2 Merged default into unary-array-cwise-functors 2015-04-20 14:01:35 -04:00
Deanna Hood
2ab4922431 Make html directory before generating output image there 2015-03-18 07:24:13 +10:00
Deanna Hood
1c78d6f2a6 Add boolean not operator (!) array support 2015-03-17 08:29:57 +10:00
Deanna Hood
fef4e071d7 Rename isinf to isInf 2015-03-17 05:58:47 +10:00
Deanna Hood
46cf9cda32 Add isfinite array support as isFinite 2015-03-17 04:33:12 +10:00
Deanna Hood
7b829940d1 Add code snippets for new methods 2015-03-17 03:40:28 +10:00
Gael Guennebaud
8fdcaded5e merge 2015-03-04 10:18:08 +01:00
Gael Guennebaud
3dca4a1efc Update manual wrt new LSCG solver. 2015-03-04 09:35:30 +01:00
Marc Glisse
37a93c4263 New scoring functor to select the pivot.
This is can be useful for non-floating point scalars, where choosing the biggest element is generally not the best choice.
2015-03-03 17:08:28 +01:00
Gael Guennebaud
fc5c3e85e2 Fix bug #961: eigen-doc.tgz included part of itself. 2015-02-18 15:47:01 +01:00
Gael Guennebaud
69fa405096 Update circulant custom expression example 2015-02-16 17:21:16 +01:00
Gael Guennebaud
cd679f2c47 Fix doc: setConstant does not exist for SparseMatrix. 2015-01-14 22:06:09 +01:00
Gael Guennebaud
db5b0741b5 Fix bug #925: typo in MatLab versions of middleRows 2015-01-04 21:39:50 +01:00
Jitse Niesen
ce2035af86 New doc page on implementing a new expression class. 2014-09-27 23:25:58 +01:00
Gael Guennebaud
fafc829424 bug #804: copy group__TopicUnalignedArrayAssert.html to TopicUnalignedArrayAssert.html as the second is linked to by old Eigen versions. 2014-09-07 22:38:09 +02:00
Gael Guennebaud
305aa1f9c5 Add examples for hnormalized and homogenous (fix bug #846) 2014-09-02 10:47:40 +02:00
Georg Drenkhahn
0ba490cf80 Fixed CMakeLists.txt files to prevent CMake 3.0.0 warnings about deprecated LOCATION target property.
Small whitespace cleanup in CMakelLists.txt.
2014-08-22 12:13:07 +02:00
Gael Guennebaud
339f14b8d1 bug #826: document caveats in 1x1 and 2x1 constructors. 2014-07-21 13:43:48 +02:00
Christoph Hertzberg
68eafc10b1 Add note to EIGEN_DONT_PARALLELIZE into preprocessor documentation page (requested in IRC) 2014-07-18 15:42:12 +02:00
Christoph Hertzberg
1cb71a8782 bug #138: Make building of internal documentation configurable via cmake flag 2014-07-18 14:34:58 +02:00
Chen-Pang He
85777fc131 Mark internal namespace as \internal 2014-07-06 13:45:54 +08:00
Chen-Pang He
7a915f6846 Move Doxygen-only stuff to *.dox 2014-07-05 22:41:58 +08:00
Christoph Hertzberg
324e7e8fc9 Removed the deprecated EIGEN2_SUPPORT, as previously announced. A compilation error is raised, if this compile-switch is defined. The documentation references to the corresponding pages from Eigen3.2 now. Also, the Eigen2 testsuite has been removed. 2014-07-01 16:58:11 +02:00
Christoph Hertzberg
d73ee84d37 Disabled HIDE_SCOPE_NAMES (default doxygen setting). This might help to avoid API confusions as in bug #830. 2014-06-25 22:44:43 +02:00
Christoph Hertzberg
0ddde223e9 Fixed typos 2014-06-23 11:00:52 +02:00
Gael Guennebaud
1fdef63d1f Explain how to export sparse linear problems in matrix-market format. 2014-06-20 13:23:33 +02:00
Jitse Niesen
de150b1e14 Add documentation and very simple test for array atan(), part 2
(files I forget in the previous commit).
2014-06-19 15:12:33 +01:00
Gael Guennebaud
95ecd582a3 Update decompositions tables 2014-06-17 09:37:07 +02:00
Mark Borgerding
e3ab46b8c9 AsciiQuickReference: added .real(), .imag()
(transplanted from 11462c1a29
)
2014-05-16 13:45:35 -04:00
Mark Borgerding
c794099e69 fixed AsciiQuickReference typo: LinSpace -> LinSpaced
(transplanted from e667819055
)
2014-05-08 15:14:12 -04:00
Benjamin Chretien
e5d0cb54a5 Fix typo in Reductions tutorial. 2014-04-17 18:49:23 +02:00
Jitse Niesen
a91a7a1964 doc: Add references to Cholesky methods in SelfAdjointView. 2014-04-07 14:14:48 +01:00
yoco
9c832fad60 add reshape() snippets 2014-01-18 04:53:46 +08:00
yoco
1e1d0c15b5 add example code for Reshape class 2014-01-18 04:43:29 +08:00