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
6,449 Commits 11 Branches 89 Tags 168 MiB
274b1f5d7e
Commit Graph

639 Commits

Author SHA1 Message Date
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
Gael Guennebaud
d428b620aa add the multithreading topic in the topic list 2012-06-21 10:54:16 +02:00
Gael Guennebaud
6f3057f624 extend documentation of *Support modules 2012-06-21 10:51:22 +02:00
Jitse Niesen
8c71d7314b Fix some typos in sparse tutorial. 2012-06-20 09:52:45 +01:00
Gael Guennebaud
52dce0c126 significantly extend the tutorial of sparse matrices 2012-06-20 09:28:32 +02:00
Gael Guennebaud
1727373706 fix geometry tutorial about scalings. 2012-06-18 22:07:13 +02:00
Gael Guennebaud
47a77d3e38 update custom scalar type doc 2012-06-18 21:49:55 +02:00
Jitse Niesen
148587e229 Update custom scalar example, based on unstable/Eigen/AdolcForward . 2012-06-16 20:35:59 +01:00
Gael Guennebaud
b9f25ee656 bug #466: better fix for the race condition: this new patch add an initParallel() 
function which must be called at the initialization time of any multi-threaded
application calling Eigen from multiple threads.
 2012-06-14 14:24:15 +02:00
Gael Guennebaud
bc580bbffb fix typo 2012-06-11 18:49:30 +02:00
Gael Guennebaud
b9f0eabd93 discourage users to user developer preprocessor directives 2012-06-06 15:36:08 +02:00
Desire NUENTSA
b202c5ed2f The sparse quick reference guide is not ready 2012-05-25 18:02:38 +02:00
Desire NUENTSA
2fecd818c4 Add a preliminary reference guide on sparse interface 2012-05-25 17:52:11 +02:00
Jitse Niesen
b5f70814c1 Warn users against dangerous macros. 
Also, mark EIGEN_DEFAULT_TO_ROW_MAJOR as internal (see also bug #422).
 2012-05-13 21:42:45 +01:00
Jitse Niesen
3c412183b2 Get rid of include directives inside namespace blocks (bug #339). 2012-04-15 11:06:28 +01:00
Gael Guennebaud
70284b7eff suppress generation of TEMPLATE_RELATIONS: they are useful but take much too much space 2012-02-09 21:42:58 +01:00
Tim Holy
44b19b432c Add a tutorial page on the Map class, and add a section to FunctionsTakingEigenTypes about multiple-argument functions and the pitfalls when using Map/Expression types. 2012-02-08 22:11:12 +01:00
Gael Guennebaud
1763f86364 add the recent setFromTriplets() feature in the manual 2012-02-04 10:44:07 +01:00
Jitse Niesen
d6bf9f848a Correct description of rankUpdate() in quick reference guide. 
Thanks to Sameer Agarwal for pointing out this mistake.
(transplanted from bc0fc5d21e
)
 2012-01-09 12:57:11 +00:00
Gael Guennebaud
15d781b64c we need to define EXTRACT_ALL to YES to get doxygen see the whole hierarchy. Exclude internal::* from the doc. 2011-12-20 10:25:54 +01:00
Gael Guennebaud
fcc966b40d workaround doxygen limitation to follow the base class of PlainObjectBase 2011-12-19 22:13:11 +01:00
Gael Guennebaud
1aa6c7f122 fix sparse insertion example 2011-12-11 17:18:14 +01:00
Gael Guennebaud
37f304a2e6 add a "using MKL" documentation page, add a minimal documentation of PARDISO wrapper classes, refine a bit the EIGEN_USE_* logic 2011-12-09 16:52:37 +01:00
Jitse Niesen
dd232e30b0 Document QuaternionBase, minor doc improvements. 
* Document class QuaternionBase so that docs for members are displayed.
* Remove obsolete \redstar refering to Array module
* Fix typo in Constants.h
* Document EIGEN_NO_AUTOMATIC_RESIZING
 2011-12-08 14:22:06 +00:00
Gael Guennebaud
c861e05181 fix matrix names in the insertion example 2011-12-03 18:14:51 +01:00
Gael Guennebaud
3f56de2628 improve sparse manual 2011-12-03 10:26:00 +01:00
Jitse Niesen
a0bcaa88af Extend tutorial page on broadcasting to reflect recent changes. 2011-12-01 21:16:07 +00:00
Gael Guennebaud
f56316f7ed add two alternative solutions to the problem of fixed size members 2011-11-25 13:46:48 +01:00
Gael Guennebaud
70206ab1e1 draft of the new sparse manual reflecting the new sparse module 2011-11-24 17:32:30 +01:00
Gael Guennebaud
57d1ccb2dc fix compilation of doc (broken by changeset bc6d78982f 
- General tightening/testing of vectorwise ops)
 2011-11-24 17:30:55 +01:00
Jitse Niesen
45a6bb34c3 Add simple example on how to compute Cholesky decomposition. 2011-11-07 17:14:06 +00:00
Gael Guennebaud
cdd3e85060 Automatically produce a tgz archive of the documentation. 2011-11-05 21:59:36 +01:00
Jitse Niesen
a594ac3966 Allow for more iterations in SelfAdjointEigenSolver (bug #354). 
Add an assert to guard against using eigenvalues that have not converged.
Add call to info() in tutorial example to cover non-convergence.
 2011-11-02 14:18:20 +00:00
Gael Guennebaud
57207239f3 Mention that the axis in AngleAxis have to be normalized. 2011-11-01 09:40:51 +01:00
Gael Guennebaud
c1170d2e93 update the decomposition catalogue 2011-10-14 21:21:38 +02:00
Jitse Niesen
e0a6ce50dd Typo in geometry tutorial. 2011-09-19 21:57:26 +01:00
Jitse Niesen
59b83c14fd Write page on template and typename keywords in C++. 
After yet another question on the forum, I decided to write something on this
common issue. Now we just need to link to this and get people to read it.
Thanks to mattb on the forum for some links. Caveat: IANALL (I am not a
language lawyer).
 2011-09-10 09:18:18 +01:00
Jitse Niesen
7898281b2b Put docs for unsupported modules in right place. 
Doxygen was confused by the unsupported modules being partly in the doc/
directly, instead of completely in unsupported/doc/ . Thus, the link to
the unsupported modules on the server did not work (I think this manifested
itself after doxygen was upgraded on the server).
 2011-09-07 04:19:12 +01:00
Tim Holy
16a2d896bc Relatively straightforward changes to wording of documentation, focusing particularly on the sparse and (to a lesser extent) geometry pages. 2011-06-20 22:47:58 -05:00
Tim Holy
4a95badf74 A first tiny test commit: fix a spelling error in the documentation. 2011-06-19 14:39:19 -05:00
Zach Ploskey
642d452921 Suggest placing Eigen directory in system include path. 2011-06-17 15:46:50 -07:00
Zach Ploskey
e3491beb48 Fixed a few typos and cleaned up some language. 2011-06-17 15:42:15 -07:00