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
Henry de Valence
033ee7f6d9
Fix typo: 'explicitely' -> 'explicitly'
2014-03-08 00:44:56 -05:00
Gael Guennebaud
72461be962
Fix typo and formating
2014-03-07 23:13:14 +01:00
Olivier Saut
47679c50ae
Typo in the example for Eigen::SelfAdjointEigenSolver::eigenvectors, the first eigenvector should be col(0) not col(1)
2014-03-03 14:44:39 +01:00
Jitse Niesen
7ea6ef8969
Fix documentation of MatrixBase::applyOnTheLeft (bug #739 )
...
Add examples; move methods from EigenBase.h to MatrixBase.h
2014-02-12 14:03:39 +00:00
Christoph Hertzberg
e170e7070b
Added examples for casting, made better examples for Maps
2014-02-11 17:27:14 +01:00
Gael Guennebaud
6cf938df53
Add a minimalistic page on CUDA with Eigen.
2014-01-24 13:24:30 +01:00
Jitse Niesen
aa0db35185
Add doc page on computing Least Squares.
2014-01-18 01:16:17 +00:00
Gael Guennebaud
92190a1caf
Add an example showing how to use C++11 random distributions
2014-01-07 20:23:35 +01:00
Gael Guennebaud
ac409f51f1
Document the fact that Random and setRandom are not reentrant (so not thread-safe)
2014-01-07 20:17:59 +01:00
Christoph Hertzberg
276801b25a
Fixed and simplified Matlab code and added further block-related examples
2013-11-29 19:54:01 +01:00
Gael Guennebaud
5d1291a4de
Document how to reproduce matlab's rot90
2013-11-19 11:51:16 +01:00
Gael Guennebaud
c6da881849
Fix bug #674 : typo in documentation example for BiCGSTAB. They are now proper snippet files.
2013-10-16 15:25:39 +02:00
Thomas Capricelli
6bef527f9d
uniformize piwik code among branches
2013-10-11 20:46:18 +02:00
Gael Guennebaud
d9381598bc
Allows EIGEN_STACK_ALLOCATION_LIMIT to be 0 for no limit
2013-08-21 14:29:00 +02:00
Gael Guennebaud
7bca2910c7
Make the static assertions on maximal fixed size object use EIGEN_STACK_ALLOCATION_LIMIT, and raise its default value to 128KB
2013-08-20 13:59:33 +02:00
Gael Guennebaud
d4dd6aaed2
Fix bug #642 : add vectorization of sqrt for doubles, and make sqrt really safe if EIGEN_FAST_MATH is disabled
2013-08-19 16:02:27 +02:00
Gael Guennebaud
ace2ed7b87
Fix broken link on transforming normals
2013-08-12 13:38:25 +02:00
Gael Guennebaud
956251b738
bug #638 : fix typos in sparse tutorial
2013-08-12 13:37:47 +02:00
Jitse Niesen
c13e9bbabf
QuickReference.dox: std::tan(array) --> tan(array), same for other functions.
2013-08-11 10:17:23 +01:00
Jitse Niesen
616f9cc593
doc: Explain type of result for VectorwiseOp member functions.
...
Prompted by a question on the forum.
2013-08-06 09:49:44 +01:00
Jitse Niesen
2f0faf117e
Remove LinearLeastSquares.dox , which should not have been added.
...
Accidentally included in changeset e37ff98bbb
.
2013-08-06 08:03:39 +01:00
Jitse Niesen
8fdffdd573
Move inheritance from Eigen example in stand-alone file.
...
Also fix a small mistake (Vector3d instead of VectorXd).
2013-08-02 22:33:12 +01:00
Gael Guennebaud
f2aba7a768
Remove obsolete sentence on LPGL in MKL doc.
2013-07-15 23:25:01 +02:00
Gael Guennebaud
9a16519d62
Extend the "functions taking Eigen type" doc page to present the Ref<> option.
2013-07-13 12:36:55 +02:00
Gael Guennebaud
4020d4286f
Fix bug in sparse documentation.
2013-07-04 06:49:24 +02:00
Jitse Niesen
4e458d309c
Fix some doxygen errors and warnings.
2013-07-02 14:08:12 +01:00
Jitse Niesen
419b5cff44
doc: Mention vec=vec.head(n) in aliasing page.
2013-07-02 13:35:36 +01:00
Jitse Niesen
4e6d746514
Avoid phrase "static allocation" for local storage on stack (bug #615 ).
2013-06-18 14:35:12 +01:00
Jitse Niesen
e37ff98bbb
Implement mixed static/dynamic-size .block() (bug #579 )
2013-06-18 14:29:15 +01:00
Jitse Niesen
79bd6fa5ee
Require at least cmake version 2.8.2 (bug #606 ).
2013-06-17 22:12:01 +01:00
Gael Guennebaud
a4a575e2a3
fix bug #597 : typo in sparse documentation
2013-06-10 12:13:31 +02:00
Thomas Capricelli
11a9091084
fix a weird bug where a space was missing before a link
2013-03-19 20:09:13 +01:00
Gael Guennebaud
5d1a74da0a
Update matlab-eigen quick ascii reff
2013-03-11 21:20:12 +01:00
Desire NUENTSA
a1ddf2e7a8
Update doc for the sparse module
2013-03-05 12:55:03 +01:00
Gael Guennebaud
b6dc2613ac
Fix bug #552 : disable EIGEN_GLIBC_MALLOC_ALREADY_ALIGNED when compiling with -fsanitize=address, and allow users to manually tell whether EIGEN_MALLOC_ALREADY_ALIGNED.
2013-02-25 19:17:13 +01:00
Jitse Niesen
a054b4ee27
Be more explicit about user-defined functions in Map tutorial.
...
See discussion on mailing list on 18 + 19 Feb 2013.
2013-02-20 13:44:40 +00:00
Jitse Niesen
ba653105a2
Remove confusing transpose() in setLinSpaced() docs.
2013-02-18 17:27:41 +00:00
Gael Guennebaud
5115f4c504
add EIGEN_INITIALIZE_MATRICES_BY_NAN
2013-02-07 18:07:07 +01:00
Gael Guennebaud
a3b94d26c8
Remove TOC numbering, and minor improvement in overview.
2013-01-12 20:34:52 +01:00
Gael Guennebaud
50625834e6
SparseQR: clean a bit the documentation, fix rows/cols methods, remove rowsQ methods and rename matrixQR to matrixR.
2013-01-12 09:40:31 +01:00
Gael Guennebaud
cc444bbbf9
update unsupported module documentation to be conformed with new documentation style
2013-01-11 10:41:26 +01:00
Gael Guennebaud
109cbb6ad3
typos
2013-01-09 17:44:25 +01:00
Gael Guennebaud
dcc1754f05
update javascript hacks for doxygen 1.8.3
2013-01-09 00:40:48 +01:00
Gael Guennebaud
2abe7d8c6e
Rename the dox files: the number prefixes are not needed anymore
2013-01-06 23:57:54 +01:00
Gael Guennebaud
091a49cad5
Clean the manual page titles, links and intro.
2013-01-06 23:48:59 +01:00
Thomas Capricelli
c71c06b71f
fix typo
2013-01-06 14:39:20 +01:00
Gael Guennebaud
86983fa1ff
Update the overview page to reflect the new organisation
2013-01-05 21:25:41 +01:00
Gael Guennebaud
2de69c2f26
Doc presentation:
...
- remove the "modules|classes" link for module pages (they are already in the TOC)
- fine tune the TOC css
2013-01-05 17:14:14 +01:00
Gael Guennebaud
93ee82b1fd
Big changes in Eigen documentation:
...
- Organize the documentation into "chapters".
- Each chapter include many documentation pages, reference pages organized as modules, and a quick reference page.
- The "Chapters" tree is created using the defgroup/ingroup mechanism, even for the documentation pages (i.e., .dox files for which I added an \eigenManualPage macro that we can switch between \page or \defgroup ).
- Add a "General topics" entry for all pages that do not fit well in the previous "chapters".
- The highlevel struture is managed by a new eigendoxy_layout.xml file.
- remove the "index" and quite useless pages (namespace list, class hierarchy, member list, file list, etc.)
- add the javascript search-engine.
- add the "treeview" panel.
- remove \tableofcontents (replace them by a custom \eigenAutoToc macro to be able to easily re-enable if needed).
- add javascript to automatically generate a TOC from the h1/h2 tags of the current page, and put the TOC in the left side panel.
- overload various javascript function generated by doxygen to:
- remove the root of the treeview
- remove links to section/subsection from the treeview
- automatically expand the "Chapters" section
- automatically expand the current section
- adjust the height of the treeview to take into account the TOC
- always use the default .css file, eigendoxy.css now only includes our modifications
- use Doxyfile to specify our logo
- remove cross references to unsupported modules (temporarily)
2013-01-05 16:37:11 +01:00
Gael Guennebaud
2ea1e49a08
Doc: replace manual TOC by doxygen's \tableofcontents command
2012-12-28 18:58:07 +01:00
Gael Guennebaud
ded70b8b58
Doc: remove page margins and limits to 60em paragraphes only instaead of the entire page (many declarations and tables are larger than 60em anyway)
2012-12-28 18:57:10 +01:00
Gael Guennebaud
3f82401890
Update doxygen files to doxygen version 1.8
2012-12-28 18:52:53 +01:00
Gael Guennebaud
f41d96deb9
Fix several documentation issues
2012-12-24 13:33:22 +01:00
Christoph Hertzberg
c69577ea31
Fix bug #531 : Empty line in <table> made doxygen render it as paragraphs
2012-12-17 16:13:42 +01:00
Gael Guennebaud
8719b1bf16
fix geometry tutorial
2012-11-29 22:48:13 +08:00
Desire NUENTSA
cfa8032ffb
bug #517 : Small typo in AsciiQuickReference
2012-10-03 09:48:33 +02:00
Desire NUENTSA
72bfed5e20
Add forgotten SparseLUBase
2012-09-27 11:34:56 +02:00
Gael Guennebaud
1edb396542
fix minor typo in doc
2012-09-26 19:24:41 +02:00
Gael Guennebaud
24f371bdb4
Merged in jdh8/eigen (pull request PR-16)
2012-09-08 12:16:49 +02:00
Desire NUENTSA
fdd0f0c5fc
merge Sparse LU branch
2012-09-07 13:18:16 +02:00
Desire NUENTSA
063705b5be
Add tutorial for sparse solvers
2012-09-07 13:14:57 +02:00
Chen-Pang He
d4144583bb
Write dox for assertions
2012-08-31 21:53:02 +08:00
Chen-Pang He
d23134e4a7
Avoid inefficient 2x2 LU. Move atanh to internal for maintainability.
2012-08-30 23:40:30 +08:00
Chen-Pang He
d0ee31aea6
Fix dox and tabbing
2012-08-29 01:56:23 +08:00
Gael Guennebaud
75435079ca
fix bug #499 : the image was missing because of a dependency issue when building/executing the "special" examples
2012-08-27 11:11:25 +02:00
Gael Guennebaud
aa1aa36d6d
simplify eigen-doc.tgz file generation, and make it more future proof
2012-08-27 10:56:44 +02:00
Gael Guennebaud
904c2e6cfb
remove EXTRACT_ALL
2012-08-27 10:30:10 +02:00
Thomas Capricelli
edc496f087
add piwik code to documentation (web stats engine)
2012-08-21 22:36:29 +02:00
Jitse Niesen
dee866a99a
Undo incorrect fix in previous commit, and fix real mistake instead.
2012-08-17 15:36:37 +01:00
Jitse Niesen
5eefca637e
Documentation fixes. Thanks to Rodney Sparapani for reporting these.
2012-08-17 14:49:18 +01:00
Gael Guennebaud
6f54269829
add an example for GeneralizedEigenSolver
2012-07-28 18:00:54 +02:00
Alexey Korepanov
d937e67b48
RealQZ: added example and some code comments
2012-07-28 08:24:44 -05:00
Gael Guennebaud
f23dd7c6f1
Fix typo in the doc: s/Succeeded/Success
2012-07-28 13:07:45 +02:00
Gael Guennebaud
54559094ec
document EIGEN_MPL2_ONLY
2012-07-14 09:56:03 +02:00
Jitse Niesen
60edf02f6f
doc: Typo in CustomizingEigen, introduced in previous commit.
...
Thanks to Christoph Hertzberg for noting this.
2012-07-05 13:56:28 +01:00
Jitse Niesen
b582b2ebdc
doc: Add constructor to example for inheritance.
...
See "Error in Inheriting Eigen::Vector3d" on forum.
2012-07-05 13:36:02 +01:00
Gael Guennebaud
9a97dac4d9
Doc: add an example for HouseholderQR::householderQ()
2012-07-02 16:33:32 +02:00