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
Gael Guennebaud
52dce0c126
significantly extend the tutorial of sparse matrices
2012-06-20 09:28:32 +02: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
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
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
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
Benoit Jacob
ea7d872181
documentation fixes
2011-02-27 17:43:10 -05:00
Jitse Niesen
a6da803873
Document DenseCoeffsBase
2010-08-22 17:30:31 +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
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
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
Benoit Jacob
e5de9e5226
Remove \nonstable yet. The stability rules for Eigen3 are much simpler:
...
- all what's not in unsupported/ is considered stable API
(except internal stuff e.g. expression templates).
2010-06-29 10:10:47 -04:00
Benoit Jacob
38facbd55b
kill the LeastSquares module.
...
I didn't even put it in Eigen2Support because it requires several other modules. But if you want we can always create a new module, Eigen2Support_LeastSquares...
2010-04-29 10:40:52 -04:00
Hauke Heibel
37d4505228
More documentation improvements.
2010-01-16 15:43:11 +01:00
Hauke Heibel
624902f559
Enabled class diagrams (requires dot, i.e. graphviz).
...
Adapted the style sheet in order to center class diagrams.
2010-01-13 17:59:42 +01:00
Gael Guennebaud
7d3fe69eff
Various documentation updates:
...
- update the tutorial
- update doc of deprecated cwise function
- update cwise doc snippets
2010-01-06 17:18:38 +01:00
Jitse Niesen
2026ea7ff2
Coax doxygen in producing better docs for MatrixFunctions.
...
The //@{ ... //@} in unsupported/Eigen/MatrixFunctions for some reason
caused doxygen to list the constructor of the MatrixExponential class
as a separate function in the MatrixFunctions module without any reference
to the class; very confusing.
2009-12-11 15:54:21 +00:00
Jitse Niesen
8bfa354ee3
Documentation clean up.
...
* remove non-existant reference to CwiseAll
* define \householder_module (used in HouseholderSequence.h)
* update I01_TopicLazyEvaluation.dox - Product is now called GeneralProduct
* remove reference to list of examples which was deleted ages ago
* rename PartialLU_solve.cpp snippet to PartialPivLU_solve.cpp
2009-12-08 15:12:27 +00:00
Thomas Capricelli
120882c4f1
fix another 'duplicated content in doxygen pages' bug : exclude *.orig
...
files
2009-11-30 19:42:00 +01:00
Benoit Jacob
b5f4636d42
* eigen2->eigen3
...
* bump version to 2.91.0
* add FindEigen3.cmake
2009-11-19 12:09:04 -05:00
Benoit Jacob
e8d0dbf82e
PermutationMatrix:
...
* make multiplication order not be reversed
* release-quality documentation
2009-11-16 15:07:33 -05:00
Thomas Capricelli
e06aa749a4
doxygen : exclude diff files
2009-11-10 22:17:23 +01:00
Benoit Jacob
6b48e932e9
*port the Cholesky module to the new solve() API
...
*improve documentation
2009-10-29 21:11:05 -04:00
Benoit Jacob
68d48511b2
move PartialLU to the new API
2009-10-21 17:06:42 -04:00
Benoit Jacob
0ad3494bd3
fix docs
2009-09-22 21:51:23 -04:00
Benoit Jacob
ab5cc8284a
convert LU::solve() to the new API
2009-09-22 20:58:29 -04:00
Gael Guennebaud
68b28f7bfb
rename the EigenSolver module to Eigenvalues
2009-09-04 09:23:38 +02:00
Gael Guennebaud
a54b99fa72
move eigen values related stuff of the QR module to a new EigenSolver module.
...
- perhaps we can find a better name ?
- note that the QR module still includes the EigenSolver module for compatibility
2009-09-03 11:39:44 +02:00
Gael Guennebaud
9515b00876
remove the \addexample tags
2009-09-03 11:22:42 +02:00
Gael Guennebaud
16c7b1daab
add examples for makeJacobi and makeGivens
2009-09-03 11:17:16 +02:00
Hauke Heibel
db5647abae
Added Umeyama implementation.
2009-05-26 19:22:25 +02:00
Gael Guennebaud
95db32fcdc
setup the unsupported directory structure.
...
The unsupported module documentation is automatically generated in:
build/doc/unsupported/
with bidirectional cross references.
I leave a class Foo in AdolcForward module to illustrate the
cross-reference behavior. I will remove it in the next commit.
2009-02-04 15:37:00 +00:00
Gael Guennebaud
44a527dfa5
* classify and sort the doxygen "related pages"
...
by tweaking the filename and adding 2 categories:
Troubleshooting and Advanced
* use the EXCLUDE_SYMBOLS to clean the class list
(insteaded of a homemade bash script)
* remove the broken "exemple list"
* re-structure the unsupported directory as mentionned in the ML and
integrate the doc as follow:
- snippets of the unsupported directory are directly imported from the
main snippets/CMakefile.txt (no need to duplicate code)
- add a top level "Unsupported modules" group
- unsupported modules have to defined their own sub group and nest it
using \ingroup Unsupported_modules
- then a pair of //@{ //@} will put everything in the submodule
- this is just a proposal !
2009-02-04 09:44:44 +00:00
Benoit Jacob
a79deafc6d
* mark Geometry as experimental
...
* install QtAlignedMalloc
* finish the renaming Regression->LeastSquares
* install LeastSquares directory (!!!)
* misc dox fixes
2009-01-26 13:53:43 +00:00
Benoit Jacob
385fd3d918
* clarify the situation with experimental parts
...
* remove all what was marked deprecated
2009-01-19 15:02:24 +00:00
Gael Guennebaud
86a192681e
* Started a tutorial page for sparse matrix.
...
* Updated Mainpage.dox's directives used by kde's scripts
2009-01-16 17:20:12 +00:00
Gael Guennebaud
ec0b2f900c
fix a couple of doxygen issues
2009-01-13 08:30:17 +00:00
Benoit Jacob
789ea9d676
unless i find more failures in the tests, this will be beta3...
...
* fixes for mistakes (especially in the cast() methods in Geometry) revealed by the new "mixing types" test
* dox love, including a section on coeff access in core and an overview in geometry
2008-12-22 20:50:47 +00:00
Alexander Neundorf
84cc69f0f3
-add quotes around the configured directories so build dirs with spaces produce some errors less
...
Alex
2008-12-02 13:04:32 +00:00
Alexander Neundorf
6b3d0e68e2
-use the cmake-provided Eigen_(SOURCE|BINARY)_DIR variables instead of setting own versions (EIGEN_(SOURCE|BINARY)_DIR
...
Alex
2008-12-02 11:00:51 +00:00
Gael Guennebaud
582c1f92c8
doc: add a "non stable" warning for parts which are not part
...
of the stable API yet and a couple of other minor doc updates...
2008-11-22 19:51:05 +00:00
Gael Guennebaud
a3b89e0ee6
tutorial: add array module warnings when needed
2008-11-17 15:38:57 +00:00
Benoit Jacob
d74916e4fe
same thing with EIGEN_BINARY_DIR. Now the doc generation works from kdesupport.
2008-08-31 15:20:25 +00:00
Benoit Jacob
c931867909
also use EIGEN_SOURCE_DIR here. according to grep this was the last place to
...
change.
2008-08-31 15:12:55 +00:00
Gael Guennebaud
063d1bb811
tweak root/Mainpage.dox to make it compatible with kde's doxygen.sh script
...
plus some hacks to compile the examples from doxygen...
Hopefully, api.kde.org/eigen2 will be beautiful by tomorrow....
2008-08-29 16:17:06 +00:00
Gael Guennebaud
3ced3f91c2
* temporarily remove doxygen customization, we'll see if that fix api.kde.org
...
but I no hope, that would be too simple !
* added Rotation2D typedefs
* remove CoreDeclarations header file
2008-08-28 15:28:23 +00:00