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
