README.txt
1This directory contains contributions from various users.
2They are provided "as is", without any support. Nevertheless,
3most of them are subject to be included in Eigen in the future.
4
5In order to use an unsupported module you have to do either:
6
7 - add the path_to_eigen/unsupported directory to your include path and do:
8 #include <Eigen/ModuleHeader>
9
10 - or directly do:
11 #include <unsupported/Eigen/ModuleHeader>
12
13
14If you are interested in contributing to one of them, or have other stuff
15you would like to share, feel free to contact us:
16http://eigen.tuxfamily.org/index.php?title=Main_Page#Mailing_list
17
18Any kind of contributions are much appreciated, even very preliminary ones.
19However, it:
20 - must rely on Eigen,
21 - must be highly related to math,
22 - should have some general purpose in the sense that it could
23 potentially become an offical Eigen module (or be merged into another one).
24
25In doubt feel free to contact us. For instance, if your addons is very too specific
26but it shows an interesting way of using Eigen, then it could be a nice demo.
27
28
29This directory is organized as follow:
30
31unsupported/Eigen/ModuleHeader1
32unsupported/Eigen/ModuleHeader2
33unsupported/Eigen/...
34unsupported/Eigen/src/Module1/SourceFile1.h
35unsupported/Eigen/src/Module1/SourceFile2.h
36unsupported/Eigen/src/Module1/...
37unsupported/Eigen/src/Module2/SourceFile1.h
38unsupported/Eigen/src/Module2/SourceFile2.h
39unsupported/Eigen/src/Module2/...
40unsupported/Eigen/src/...
41unsupported/doc/snippets/.cpp <- code snippets for the doc
42unsupported/doc/examples/.cpp <- examples for the doc
43unsupported/doc/TutorialModule1.dox
44unsupported/doc/TutorialModule2.dox
45unsupported/doc/...
46unsupported/test/.cpp <- unit test files
47
48The documentation is generated at the same time than the main Eigen documentation.
49The .html files are generated in: build_dir/doc/html/unsupported/
50
51