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
Benoit Jacob
6f2ba1f52b
typo reported by Don Lorenzo
2011-01-28 10:00:34 -05:00
Benoit Jacob
5331fa3033
fix compilation of LU class example
2011-01-24 07:41:47 -05:00
Jitse Niesen
47a9d2ed54
Document HouseholderSequence.
...
Incomplete: I did not explain the difference between OnTheLeft and OnTheRight,
and there is only one example.
2011-01-02 16:59:44 +00:00
Benoit Jacob
26c2afd55a
fix compile errors in Tridiagonalization and in doc examples
2010-12-30 04:52:20 -05:00
Trevor Irons
e112ad8124
In QuickRefPage LinSpaced is improperly documented.
2010-12-29 10:08:41 -07:00
Jitse Niesen
d6a5ba5a08
Rename EIGEN_DENSESTORAGEBASE_PLUGIN to EIGEN_PLAINOBJECTBASE_PLUGIN.
2010-12-29 19:12:39 +00:00
Jitse Niesen
657013c974
Mention ptr_fun in docs for .unaryExpr()
2010-12-27 16:35:25 +00:00
Jitse Niesen
265e1ef4ef
Extend doc page on preprocessor directives.
2010-12-27 16:34:58 +00:00
Jitse Niesen
8db9acbc16
Move doxygen comments for EIGEN_NO_DEBUG from source to I14.
...
This reverts changeset 76fbe94279
. Benoit and I agree that my
approach there (to use doxygen comments) pollutes the code too much.
2010-12-27 15:07:11 +00:00
Jitse Niesen
840c4e1ab5
Move section on preprocessor directives from I00 to its own page.
2010-12-27 15:07:07 +00:00
Jitse Niesen
42a050dc68
Finish doc page on aliasing.
2010-12-27 15:06:55 +00:00
Benoit Jacob
86d3711fb7
remove EIGEN_REF_TO_TEMPORARY, clarify docs
2010-12-25 16:45:25 -05:00
Jitse Niesen
4a5ebcd1ce
Fix compilation of Tridiagonalization_diagonal example.
...
After changeset 0d63212257
, matrixT() is a real matrix even if the matrix
which is decomposed is complex.
2010-12-12 13:53:42 +00:00
Gael Guennebaud
c49c013c47
add main ei_* functions into Eigen2Support
2010-12-03 11:22:35 +01:00
Gael Guennebaud
14208eb478
add a word about the ei_ prefix change in Eigen2 -> Eigen3 doc page.
2010-12-03 10:54:16 +01:00
Benoit Jacob
cd1225ef14
make example compile
2010-11-24 09:18:49 -05:00
Benoit Jacob
f84cbba52a
minor fixes
2010-11-24 09:16:30 -05:00
Benoit Jacob
07f2406dc1
some dox tweaks
2010-11-24 08:23:17 -05:00
Benoit Jacob
0ab9a0a2f7
make UpperBidiagonalization internal: don't want to support it, it's not used.
...
Keeping it because it tests BandMatrix.
2010-11-23 11:12:42 -05:00
Jitse Niesen
e54c8d20cb
Docs: aliasing and component-wise operations.
2010-11-16 17:28:59 +00:00
Jitse Niesen
cad73d9cdc
Correct std::map fix (two commits ago); copy fix to aligned_allocator doc.
2010-11-12 12:06:24 +00:00
Jose Luis Blanco
9ba15cd63c
Docs: correct declaration of aligned std::map in TopicStlContainers.
2010-11-12 10:05:41 +00:00
Benoit Jacob
99ccb26cfe
add eigen2support Transform typedefs, add Eigen2To3 section on Transform
2010-10-29 09:00:35 -04:00
Benoit Jacob
4716040703
bug #86 : use internal:: namespace instead of ei_ prefix
2010-10-25 10:15:22 -04:00
Hauke Heibel
969518f99d
Improved I13_FunctionsTakingEigenTypes.dox.
...
Removed the r-value reference part and focused on EIGEN_REF_TO_TEMPORARY only.
2010-10-21 10:14:23 +02:00
Benoit Jacob
ee60fc2062
fix typo and rephrase sentence
2010-10-20 09:43:16 -04:00
Benoit Jacob
8c17fab8f5
renaming: ei_matrix_storage -> DenseStorage
...
DenseStorageBase -> PlainObjectBase
2010-10-20 09:34:13 -04:00
Benoit Jacob
e259f71477
rename PlanarRotation -> JacobiRotation
2010-10-19 21:56:26 -04:00
Gael Guennebaud
e5073746f3
allows blocks of code to be larger than the page body (like tables)
2010-10-19 16:55:49 +02:00
Gael Guennebaud
e19c6b89f5
update the position of the owl
2010-10-19 16:07:04 +02:00
Gael Guennebaud
54814eb05b
factorize CSS code, make use of the "manual" class when appropriate, clean the style of the big linear algebra table
2010-10-19 15:25:00 +02:00
Benoit Jacob
70f95ef80d
increase css max-width
2010-10-19 09:40:23 -04:00
Benoit Jacob
b1604ea553
merge
2010-10-19 09:32:19 -04:00
Benoit Jacob
b8dfc62f3c
specify max-width in em not px
2010-10-19 09:31:22 -04:00
Gael Guennebaud
6d8e7d68e4
factorize CSS code, make use of the "manual" class when appropriate, clean the style of the big linear algebra table
2010-10-19 15:25:00 +02:00
Benoit Jacob
9e3005d552
css update: max-width and margins
2010-10-19 09:18:06 -04:00
Benoit Jacob
9fa54d4cc9
move tables from class "tutorial_code" to "example"
...
also remove a align="center" in the Aliasing page -- it doesn't make sense to have 1 centered table page when all others are left aligned.
2010-10-19 08:42:49 -04:00
Gael Guennebaud
ca4bd5851c
update style of the quick ref guide
2010-10-19 11:59:11 +02:00
Gael Guennebaud
f66fe2663f
update CSS to doxygen 1.7.2, new CSS and cleaning of the tutorial
2010-10-19 11:40:49 +02:00
Benoit Jacob
3404d5fb14
improvements in pages 5 and 7 of the tutorial.
2010-10-18 09:09:30 -04:00
Benoit Jacob
1c15a6d96f
improvements in tutorial page 4 : block operations
2010-10-18 08:44:27 -04:00
Benoit Jacob
4b0fb968ea
fixed table html
2010-10-18 07:23:48 -04:00
Benoit Jacob
8356bc8d06
add jacobiSvd() method, update test & docs
2010-10-17 09:40:52 -04:00
Benoit Jacob
26129229ec
doc updates/improvements
2010-10-15 09:44:43 -04:00
Benoit Jacob
fcee1903be
update the porting guide
2010-10-15 08:48:44 -04:00
Benoit Jacob
8f0e80fe30
JacobiSVD:
...
* fix preallocating constructors, allocate U and V of the right size for computation options
* complete documentation and internal comments
* improve unit test, test inf/nan values
2010-10-14 10:14:43 -04:00
Gael Guennebaud
d9c131de5b
remove the Taucs backend : Taucs is not maintained anymore and the backend was crap anyway
2010-10-06 17:42:17 +02:00
Romain Bossart
c6503e03eb
Updates to the Sparse unsupported solvers module.
...
* change Sparse* specialization's signatures from <..., int Backend> to <..., typename Backend>. Update SparseExtra accordingly to use structs instead of the SparseBackend enum.
* add SparseLDLT Cholmod specialization
* for Cholmod and UmfPack, SparseLU, SparseLLT and SparseLDLT now use ei_solve_retval and have the new solve() method (to be closer to the 3.0 API).
* fix doc
2010-10-04 20:56:54 +02:00
Gael Guennebaud
b5f32830fd
fix geometry tutorial regarding the need to specify the "mode"
2010-10-06 13:27:14 +02:00
Hauke Heibel
dd94f10442
Docs: Improved the docs for writing functions taking Eigen types.
...
- Removed the wrong statement about the MSVC compiler.
- Reformulated "simple functions" usage.
- Reformulated the summary paragraph about writable parameters.
2010-08-27 08:19:09 +02:00
Jitse Niesen
474c2996bd
Docs: add section on resolving the aliasing issue.
2010-08-23 17:23:30 +01:00
Jitse Niesen
a6da803873
Document DenseCoeffsBase
2010-08-22 17:30:31 +01:00
Gael Guennebaud
ab41c18d60
quickly mention how to solve a sparse problem
2010-08-18 15:33:58 +02:00
Hauke Heibel
85fdcdf055
Fixed Geometry module failures.
...
Removed default parameter from Transform.
Removed the TransformXX typedefs.
Removed references to TransformXX from unit tests and docs.
Assigning Transforms to a sub-group is now forbidden at compile time.
Products should now properly support the Isometry flag.
Fixed alignment checks in MapBase.
2010-08-17 20:03:50 +02:00
Jitse Niesen
76fbe94279
Document EIGEN_NO_DEBUG macro.
...
I needed some doxygen tricks to get this to work, so it may not be worth it.
2010-08-10 11:37:23 +01:00
Jitse Niesen
530b328769
Aliasing doc: explain that some cases are detected, reverse order examples.
2010-08-08 21:20:14 +01:00
Benoit Jacob
976d7c19e8
some small improvements to the page on functions taking eigen objects.
...
- make the beginning more precise
- make the first example be a full selfcontained compiled example, no need for all the others, but having the first one doesn't hurt.
2010-08-04 21:42:32 -04:00
Hauke Heibel
5c7cb3c05c
Added more examples to the function writing tutorial including EigenBase, DenseBase, etc.
2010-08-04 17:50:46 +02:00
Hauke Heibel
d558e84f0b
Fixed some typos and reformulated a few sentences.
2010-08-04 16:40:33 +02:00
Hauke Heibel
224dd66e10
Added a tutorial on writing functions taking Eigen types.
2010-08-04 12:01:19 +02:00
Jitse Niesen
508b51cb62
Add page giving an overview of the class hierarchy.
...
This is mostly copied from the wiki, which in turn copies Benoit's email at
http://listengine.tuxfamily.org/lists.tuxfamily.org/eigen/2010/06/msg00576.html
I used ASCII art for the inheritance diagrams for now, but I don't mind
moving to GraphViz/dot as discussed earlier.
2010-08-02 11:36:44 +01:00
Jitse Niesen
a9fe75efc4
Documentation: Start special topic page on aliasing.
2010-07-31 21:37:29 +01:00
Jitse Niesen
1420f8b3a1
Several changes in comments to keep Doxygen happy.
2010-07-25 20:29:07 +01:00
Jitse Niesen
3d9764ee24
Add some more examples for the API documentation.
...
The only missing examples now are for homogeneous() and hnormalized();
I don't know what they're used for ...
2010-07-24 16:43:07 +01:00
Jitse Niesen
425444428c
Add examples for API documentation of block methods in DenseBase.
2010-07-23 22:20:00 +01:00
Jitse Niesen
2b5a0060b4
Add examples for API documentation of MatrixBase::cwiseXxx() methods.
2010-07-23 20:32:33 +01:00
Jitse Niesen
072ee3c07d
Set Doxygen config variable INCLUDE_PATH to plugins directory.
...
This is necessary to get functions like MatrixBase::cwiseAbs() documented;
otherwise doxygen can't find the include file in which they are defined.
2010-07-23 19:57:21 +01:00
Jitse Niesen
ae8425c74c
Tutorial page 7: more typical example for .all(), minor copy-editing.
2010-07-23 19:20:10 +01:00
Jitse Niesen
d0f6b1c21f
Tutorial page 6: Fix typo, add table of contents.
2010-07-22 21:52:04 +01:00
Jitse Niesen
403e672587
Extend tutorial page 5: Advanced initialization.
2010-07-22 15:53:21 +01:00
Hauke Heibel
734469e43f
Unified LinSpaced in order to be conform with other setter methods as e.g. Constant.
2010-07-22 14:04:00 +02:00
Thomas Capricelli
8e21cef80a
fix typo
2010-07-22 13:15:15 +02:00
Manoj Rajagopalan
c64c0f382f
Examples for DenseBase::middle{Rows,Cols}()
2010-06-30 11:26:31 -04:00
Jitse Niesen
3abbdfd621
Add (set)LinSpaced to quick reference guide.
2010-07-20 21:55:22 +01:00
Gael Guennebaud
87e89fea4e
add a support module for MPFR C++ with basic unit testing
2010-07-15 16:29:04 +02:00
Jitse Niesen
b0bd1cfa05
Tutorial page 4: add some text, diversify examples.
...
Use \verbinclude for output text to disable syntax highlighting.
Give tables consistent look.
2010-07-14 10:16:12 +01:00
Jitse Niesen
c36316f284
Change EXPAND_AS_DEFINED doxygen configuration option.
...
Add macros so that MatrixBase::cwiseProduct() and ArrayBase::min() are
documented, and remove one macro which is no longer used.
2010-07-13 10:14:58 +01:00
Jitse Niesen
140ad0908d
Tutorial page 3: add more cwise operations, condense rest.
2010-07-12 22:45:57 +01:00
Jitse Niesen
8e776c94c1
Tutorial page 1: Put code and output side-by-side.
2010-07-12 12:02:31 +01:00
Gael Guennebaud
19a70ae939
fix doc compilation on non 32bits systems
2010-07-11 11:01:17 +02:00
Jitse Niesen
26cfe5a958
Be consistent in how the tutorial pages link together.
2010-07-09 11:59:29 +01:00
Jitse Niesen
2c03ca3325
Small changes to tutorial page 2 (matrix arithmetic):
...
* slightly more extensive discussion of aliasing
* layout: put example code and output side-by-side
* add some links, etc
2010-07-09 11:46:07 +01:00
Carlos Becker
951da96f14
Added more redux types/examples in tutorial and fixed some display issues
2010-07-08 18:16:39 +01:00
Carlos Becker
cb3aad1d91
Reductions/Broadcasting/Visitor Tutorial added to index
2010-07-08 17:45:25 +01:00
Carlos Becker
9852e7b9cb
Reductions/Broadcasting/Visitor Tutorial added
2010-07-08 17:42:23 +01:00
Gael Guennebaud
fc3fd8ab57
mention that array = matrix is fine too
2010-07-07 18:10:11 +02:00
Jitse Niesen
49747fa4a9
Various documentation improvements.
...
* Add short documentation for Array class
* Put all classes explicitly in Core module (where applicable)
* Section on Modules in Quick Reference Guide
* Put Page 7 after Page 6 in Contents :)
2010-07-06 13:10:08 +01:00
Jitse Niesen
3428d80d20
Small changes to tutorial page 1.
2010-07-06 10:48:25 +01:00
Benoit Jacob
8cfbf33f60
fix the overview page and add mention that the wrong stack alignment issue may have been solved by gcc 4.5
2010-07-06 00:50:16 -04:00
Jitse Niesen
9fa4e9a098
Improve documentation, mostly by adding links to Quick Start Guide.
2010-07-05 10:59:29 +01:00
Gael Guennebaud
0c25f868c7
update topic page on products
2010-07-04 10:37:32 +02:00
Gael Guennebaud
41ea92d355
* update the general TOC
...
* integrate the old geometry/sparse tutorial into the new one (they are better than nothing)
* remove the old tutorial on the core module
2010-07-04 10:14:47 +02:00
Benoit Jacob
5a52f2833f
simplify and polish a bit the page 4 / block ops
2010-07-01 20:52:40 -04:00
Benoit Jacob
08c17c412e
polish the Array tutorial page
2010-07-01 20:29:13 -04:00
Benoit Jacob
962b30d75e
fix linalg tut; remove the old one
2010-06-30 19:27:30 -04:00
Hauke Heibel
34d79b6a63
Firefox specific style fix.
2010-06-30 18:31:31 +02:00
Hauke Heibel
7b74d376d3
More style fixes.
2010-06-30 18:27:27 +02:00
Hauke Heibel
e1348b9cc9
Slight pimping of the "Basic matrix manipulation" table.
...
More CSS simplifications.
2010-06-30 18:04:36 +02:00
Benoit Jacob
73db507d15
merge.
...
first time i see this: someone pushed *between*
my hg pull -u and my hg push ! I guess that means we have very high activity these days. good!
2010-06-30 10:14:09 -04:00
Benoit Jacob
4d4a23cd3e
nearly complete page 6 / linear algebra + examples
...
fix the previous/next links
2010-06-30 10:11:55 -04:00
Carlos Becker
b83225edfb
Fixed small typo in arithmetic tutorial
2010-06-30 15:08:25 +01:00
Hauke Heibel
b1741c1dc6
Fixed some doc appearance issue.
...
Started cleaning up the CSS.
2010-06-30 15:52:00 +02:00
Hauke Heibel
56fe64c15d
Fix hover background color for H2.
...
Align tutorial tables at the top.
2010-06-30 14:05:37 +02:00
Gael Guennebaud
21d940fbe4
fix unsupported module doc
2010-06-30 13:19:54 +02:00
Gael Guennebaud
020bf9e922
clean the class hierarchy
2010-06-30 13:05:07 +02:00
Hauke Heibel
c66c4b3293
Added exclusion filters.
2010-06-30 12:57:00 +02:00
Jitse Niesen
096c13ea6d
Fill in open entries in decompositions table.
2010-06-30 10:41:23 +01:00
Gael Guennebaud
1b8277fc2a
update the big linear algebra table (fixes, add notes and definitions)
2010-06-30 10:37:23 +02:00
Gael Guennebaud
a06cd0fb13
it remains only to set the status of RealSchur and EigenSolver
2010-06-29 20:59:23 +02:00
Gael Guennebaud
1f4927a28c
update the big table and add an Optimization column
2010-06-29 20:44:51 +02:00