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
Jitse Niesen
7a61a564ef
Fix snippets for operator|| and && by adding pair of parens.
2011-06-03 11:17:08 +01:00
Gael Guennebaud
35c1158ee3
add boolean || and && operators
2011-05-31 22:17:34 +02:00
Gael Guennebaud
5b71d44e18
fix bug #278 : geometry tutorial
...
(transplanted from 3cd1641dac
)
2011-05-28 22:12:15 +02:00
Jitse Niesen
781e75cbd7
Document some more preprocessor symbols:
...
EIGEN_NO_MALLOC, EIGEN_RUNTIME_NO_MALLOC, eigen_assert.
2011-05-04 14:13:20 +01:00
Jitse Niesen
a96c849c20
Document enums in Constants.h (bug #248 ).
...
To get the links to work, I also had to document the Eigen namespace.
Unfortunately, this means that the word Eigen is linked whenever it appears
in the docs.
2011-05-03 17:08:14 +01:00
Gael Guennebaud
f85db18c1c
I doubt this change was intented to be committed
...
ss: Enter commit message. Lines beginning with 'HG:' are removed.
2011-04-20 08:15:09 +02:00
Thomas Capricelli
50c00d14c8
be nice with the server : dont use -j3
2011-04-19 17:41:59 +02:00
Gael Guennebaud
0d58c36ffd
std::min/max are not implemented and they cannot be implemented easily
2011-04-04 16:26:43 +02:00
Jitse Niesen
70d5837e00
Correct typo in QuickReference doc, plus typographical improvements.
2011-04-01 16:58:51 +01:00
Benoit Jacob
bb8a25e94b
fix typos
2011-03-21 06:45:57 -04:00
Benoit Jacob
eba023d082
make compile_snippet use Eigen/Dense
2011-03-20 11:48:53 -04:00
Jitse Niesen
27f34269d5
Document EIGEN_DEFAULT_DENSE_INDEX_TYPE.
...
Also, expand description of EIGEN_DONT_ALIGN.
2011-03-11 11:15:44 +00:00
Benoit Jacob
b43d92a5a2
The Eigen2 intrusive std::vector hack really can't be supported in eigen3 (bug #215 )
2011-03-04 10:24:41 -05:00
Jitse Niesen
1180ede36d
Escape hash character in docs as required by doxygen.
2011-03-03 15:19:11 +00:00
Benoit Jacob
ea7d872181
documentation fixes
2011-02-27 17:43:10 -05:00
Gael Guennebaud
939f0327b6
mention reverse and replicate in the quick ref
2011-02-23 15:31:16 +01:00
Gael Guennebaud
eda59ffc1b
mention std::ptr_fun in the quickref guide
2011-02-17 18:07:21 +01:00
Gael Guennebaud
aea630a98a
factorize implementation of standard real unary math functions, and add acos, asin
2011-02-17 17:37:11 +01:00
Jitse Niesen
211e1f8044
Improve documentation of plugins.
2011-02-13 22:50:57 +00:00
Jitse Niesen
8bca23bbec
Mention comma initializer can be used to concatenate vectors
...
(inspired by a question on IRC)
2011-02-12 23:17:31 +00:00
Jitse Niesen
9ac68e40a0
Write topic page for storage orders.
2011-02-12 17:43:29 +00:00
Benoit Jacob
f7e4602a40
doc fixes
2011-02-11 09:55:54 -05:00
Gael Guennebaud
fe70113fab
fix Transform documention regarding Mode
2011-02-10 18:58:37 +01:00
Benoit Jacob
f3b81302cd
fix typo
2011-02-10 11:06:01 -05:00
Benoit Jacob
57b22204db
document the eigen2 support stages
2011-02-10 10:55:22 -05:00
Benoit Jacob
9105e62d0a
introduce EIGEN_MAKING_DOCS to tell whether we're compiling the docs examples
2011-02-06 12:51:42 -05:00
Benoit Jacob
02ee26a3a5
fix build of class Block examples
2011-02-06 12:43:01 -05:00
Jitse Niesen
e2d46eac42
Remove all references to EIGEN_TUNE_CPU_CACHE_SIZE.
...
This macro is no longer used as of revision 0212eec23f
.
2011-02-04 22:33:53 +01:00
Benoit Jacob
4489c56c9e
add Map static methods taking Strides, add test checking for compilation errors
2011-02-03 10:05:45 -05:00
Jason Newton
d028262e06
add tan function in Array world
2011-02-03 14:34:40 +01:00
Benoit Jacob
2d09b11a97
relax Matrix/Array(Index) ctors to allow size 0, add test.
2011-02-01 07:46:02 -05:00
Gael Guennebaud
faa1284c12
fix compilation of snippets
2011-02-01 13:28:14 +01:00