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