Mentions légales du service

Skip to content
Snippets Groups Projects
Commit 71c830c3 authored by hhakim's avatar hhakim
Browse files

Update doxygen mainpage.md

- Different version is generated depending on the type of build: pure wrappers or core+wrappers package.
- The common introduction part comes from faust.inria.fr with few addons (another paper linked + reference link to main website).
parent adaee785
No related branches found
No related tags found
No related merge requests found
...@@ -27,6 +27,11 @@ if(BUILD_DOCUMENTATION) ...@@ -27,6 +27,11 @@ if(BUILD_DOCUMENTATION)
#file(MAKE_DIRECTORY ${FAUST_INSTALL_DOC}) #file(MAKE_DIRECTORY ${FAUST_INSTALL_DOC})
#install(DIRECTORY ${PROJECT_BINARY_DIR}/doc/html DESTINATION ${FAUST_INSTALL_DOC} FILE_PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_WRITE GROUP_EXECUTE WORLD_READ WORLD_WRITE WORLD_EXECUTE) #install(DIRECTORY ${PROJECT_BINARY_DIR}/doc/html DESTINATION ${FAUST_INSTALL_DOC} FILE_PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_WRITE GROUP_EXECUTE WORLD_READ WORLD_WRITE WORLD_EXECUTE)
string(TIMESTAMP DOXYGEN_CURRENT_DATE "%Y-%m-%d - %H:%M") string(TIMESTAMP DOXYGEN_CURRENT_DATE "%Y-%m-%d - %H:%M")
if(EXCLUDE_FAUST_LIB_INSTALL)
file(READ mainpage_wrappers_inc.md INCLUDE_SPECIFIC_DOC)
else()
file(READ mainpage_cpp_inc.md INCLUDE_SPECIFIC_DOC)
endif()
configure_file(${FAUST_DOC_SRC_DIR}/mainpage.md ${PROJECT_BINARY_DIR}/doc/mainpage.md) configure_file(${FAUST_DOC_SRC_DIR}/mainpage.md ${PROJECT_BINARY_DIR}/doc/mainpage.md)
else() else()
message(WARNING "Doxygen not found, cannot generate the documentation") message(WARNING "Doxygen not found, cannot generate the documentation")
......
\mainpage FAµST Home \mainpage FAµST Library API Documentation
\section intro_sec Introduction \section intro_sec Introduction
FAµST is a C++ library that implements a way to decompose a given matrix into a product of sparse matrix in order to reduce multiplication costs by the matrix. <br>
FaµST can be widely used to speed up iterative algorithm commonly used for solving high dimensional linear inverse problems. <br>
It is delivered with Matlab wrapper. <br>
<br>
The description of Faust's project is available in articles written by Luc Le Magoarou and Rémi Gribonval at : <a href="https://hal.archives-ouvertes.fr/hal-01167948v1"> link1 </a> and <a href="https://hal.archives-ouvertes.fr/hal-01156478v1"> link2 </a>. <br>
FAµST is developped at <a href="http://www.inria.fr/en/centre/rennes"> Rennes INRIA</a> by <a href="https://team.inria.fr/panama/fr/">Panama team </a>. <br>
For more information on the FAµST Project, please visit the <a href="http://faust.inria.fr"> website</a>. <br>
<HR> The FAµST toolbox provides algorithms and data structures to decompose a given dense matrix into a product of sparse matrices in order to reduce its computational complexity (both for storage and manipulation).
FaµST can be used to:
- speedup / reduce the memory footprint of iterative algorithms commonly used for solving high dimensional linear inverse problems,
- learn dictionaries with an intrinsically efficient implementation,
- compute (approximate) fast Fourier transforms on graphs.
A general introduction to FAµST is available in the following paper:
\section install_sec Installation [1] [Le Magoarou L. and Gribonval R., “Flexible multi-layer sparse approximations of matrices and applications”](https://hal.archives-ouvertes.fr/hal-01167948), Journal of Selected Topics in Signal Processing, 2016.
See document ./gettingStartedFAuST-versionX_X.pdf to install the toolbox FAµST.
\section NamingConvention Naming conventions in the C++ FAuST project The next paper can come as complement:
- namespace : Faust::xxx
- class : Faust::MyClass / Faust::Class
- attributs : m_myAttribut / m_attribut
- methods : myMethod() / method()
- function : Faust::my_function() [2][Le Magoarou L. and Gribonval R., Gramfort A., “FAµST: speeding up linear transforms for tractable inverse problems“](https://hal.archives-ouvertes.fr/hal-01156478v1)
- variable : myVariable
- object : myObjet
- files class : faust_MyClass.x / faust_Class.x The FAµST toolbox was initially released as a Matlab implementation (versions 1.x). A C++ implementation (versions 2.x), including Matlab wrappers, is now available and the object of further developments. A Python interface is being developed.
- files function : faust_my_function.x
- files class gpu : faust_MyClass_gpu.x / faust_Class_gpu.x FAµST is developped at [Rennes INRIA](https://hal.archives-ouvertes.fr/hal-01156478v1). <br>
- files function gpu: faust_my_function_gpu.x For more information on the FAµST Project, please visit the website [faust.inria.fr](http://faust.inria.fr). <br>
<HR>
- class template gpu : Faust::MyClass<FPP,gpu> /
@INCLUDE_SPECIFIC_DOC@
<HR> <HR>
\authors Adrien Leman, Nicolas Bellot, Thomas Gautrais \authors Adrien Leman, Nicolas Bellot, Thomas Gautrais, Hakim H.
\date @DOXYGEN_CURRENT_DATE@ \date @DOXYGEN_CURRENT_DATE@
<HR> <HR>
......
\section install_sec Getting started with FAµST
See document ./gettingStartedFAuST-versionX_X.pdf to install the toolbox FAµST.
\section NamingConvention Naming conventions in the C++ FAuST project
- namespace : Faust::xxx
- class : Faust::MyClass / Faust::Class
- attributs : m_myAttribut / m_attribut
- methods : myMethod() / method()
- function : Faust::my_function()
- variable : myVariable
- object : myObjet
- files class : faust_MyClass.x / faust_Class.x
- files function : faust_my_function.x
- files class gpu : faust_MyClass_gpu.x / faust_Class_gpu.x
- files function gpu: faust_my_function_gpu.x
- class template gpu : Faust::MyClass<FPP,gpu> /
\section install_sec Getting started with FAµST
Please look at this complementary document for helping you start with FAµST really quick.
[README](./README.html)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment