README.txt
1 This directory contains contributions from various users.
2 They are provided "as is", without any support. Nevertheless,
3 most of them are subject to be included in Eigen in the future.
4
5 In 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
14 If you are interested in contributing to one of them, or have other stuff
15 you would like to share, feel free to contact us:
16 http://eigen.tuxfamily.org/index.php?title=Main_Page#Mailing_list
17
18 Any kind of contributions are much appreciated, even very preliminary ones.
19 However, 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
25 In doubt feel free to contact us. For instance, if your addons is very too specific
26 but it shows an interesting way of using Eigen, then it could be a nice demo.
27
28
29 This directory is organized as follow:
30
31 unsupported/Eigen/ModuleHeader1
32 unsupported/Eigen/ModuleHeader2
33 unsupported/Eigen/...
34 unsupported/Eigen/src/Module1/SourceFile1.h
35 unsupported/Eigen/src/Module1/SourceFile2.h
36 unsupported/Eigen/src/Module1/...
37 unsupported/Eigen/src/Module2/SourceFile1.h
38 unsupported/Eigen/src/Module2/SourceFile2.h
39 unsupported/Eigen/src/Module2/...
40 unsupported/Eigen/src/...
41 unsupported/doc/snippets/.cpp <- code snippets for the doc
42 unsupported/doc/examples/.cpp <- examples for the doc
43 unsupported/doc/TutorialModule1.dox
44 unsupported/doc/TutorialModule2.dox
45 unsupported/doc/...
46 unsupported/test/.cpp <- unit test files
47
48 The documentation is generated at the same time than the main Eigen documentation.
49 The .html files are generated in: build_dir/doc/html/unsupported/
50
51