Mentions légales du service

Skip to content
Snippets Groups Projects
Commit dc2e9c7a authored by Adrien Leman's avatar Adrien Leman Committed by hhakim
Browse files

modif doc latex

parent 961d99c1
No related branches found
No related tags found
No related merge requests found
...@@ -44,7 +44,7 @@ In order to use Matlab wrapper, follow the instructions : ...@@ -44,7 +44,7 @@ In order to use Matlab wrapper, follow the instructions :
>> setup_Faust \end{lstlisting} >> setup_Faust \end{lstlisting}
You must obtain the following message in your Matlab Command Window : You must obtain the following message in your Matlab Command Window :
\begin{lstlisting} \begin{lstlisting}
Welcome to the matlab wrapper of the FAuST C++ toolbox. Welcome to the Matlab wrapper of the FAuST C++ toolbox.
FAuST root directory is <FAuST_INSTALL_DIR> FAuST root directory is <FAuST_INSTALL_DIR>
Adding path <FAuST_INSTALL_DIR> and all its subdirectories Adding path <FAuST_INSTALL_DIR> and all its subdirectories
To get started with the FAuST Toolbox : launch quick_start To get started with the FAuST Toolbox : launch quick_start
......
%!TEX root = gettingStartedFAuST-version2_0.tex %!TEX root = gettingStartedFAuST-version2_0.tex
\chapter{Introduction}\label{sec:intro} \chapter{Introduction}\label{sec:intro}
\paragraph{What is the \FAuST toolbox?} FA$\mu$ST is a C++ toolbox, useful to decompose or approximate any given dense matrix into a product of sparse matrices, in order to reduce its computational complexity (both for storage and manipulation). \paragraph{What is the \FAuST\ toolbox ?} FA$\mu$ST is a C++ toolbox, useful to decompose or approximate any given dense matrix into a product of sparse matrices, in order to reduce its computational complexity (both for storage and manipulation).
As an example, Figure \ref{fig:presentation} shows a dens matrix \textbf{A} and sparse matrices $\mathbf{S_j}$ such that $\mathbf{A}=\prod_{j=1}^J\mathbf{S_j}$. As an example, Figure \ref{fig:presentation} shows a dens matrix \textbf{A} and sparse matrices $\mathbf{S_j}$ such that $\mathbf{A}=\prod_{j=1}^J\mathbf{S_j}$.
\begin{figure}[H] %%[!htbp] \begin{figure}[H] %%[!htbp]
...@@ -11,14 +11,14 @@ As an example, Figure \ref{fig:presentation} shows a dens matrix \textbf{A} and ...@@ -11,14 +11,14 @@ As an example, Figure \ref{fig:presentation} shows a dens matrix \textbf{A} and
\label{fig:presentation} \label{fig:presentation}
\end{figure} \end{figure}
\paragraph{Why shall I use \FAuST?} FA$\mu$ST can be used to speed up iterative algorithms commonly used for solving high dimensional linear inverse problems. The algorithms implemented in the toolbox are described in details by Le Magoarou \cite{LeMagoarou2016}. For more information on the FA$\mu$ST project, please visit the website of the project: \url{http://faust.gforge.inria.fr}. \paragraph{Why shall I use \FAuST\ ?} FA$\mu$ST can be used to speed up iterative algorithms commonly used for solving high dimensional linear inverse problems. The algorithms implemented in the toolbox are described in details by Le Magoarou \cite{LeMagoarou2016}. For more information on the FA$\mu$ST project, please visit the website of the project: \url{http://faust.gforge.inria.fr}.
%\paragraph{Brief description:} %\paragraph{Brief description:}
%$A=\prod_{j=1}^J S_j$. %$A=\prod_{j=1}^J S_j$.
%Valid Installation: Platforms, Compiler and IDE %Valid Installation: Platforms, Compiler and IDE
\paragraph{Is my platform and compiler currently supported?} \paragraph{Is my platform and compiler currently supported ?}
\FAuST\ has been tested in various configurations, and is currently delivered with a Matlab wrapper. Figure \ref{fig:recapInstall} summarizes the configurations on which \FAuST\ has been tested. \FAuST\ has been tested in various configurations, and is currently delivered with a Matlab wrapper. Figure \ref{fig:recapInstall} summarizes the configurations on which \FAuST\ has been tested.
\paragraph{How should I use this document ?} \paragraph{How should I use this document ?}
...@@ -36,23 +36,23 @@ Chapter \ref{sec:firstUse} shows quickly how to use this library and gives an ex ...@@ -36,23 +36,23 @@ Chapter \ref{sec:firstUse} shows quickly how to use this library and gives an ex
\label{fig:recapInstall} \label{fig:recapInstall}
\end{figure} \end{figure}
\paragraph{How is the code of FA$\mu$ST structured?} \paragraph{How is the code of \FAuST structured ?}
A brief outline of the code structure and status is given on Figure~\ref{fig:faustStructure}. The main C++ library called \textrm{libfaust} includes two components: A brief outline of the code structure and status is given on Figure~\ref{fig:faustStructure}. The main C++ library called \textrm{libfaust} includes two components:
\begin{itemize} \begin{itemize}
\item the "FA$\mu$ST matrix multiplication" provides efficient linear operators to efficiently manipulate your data, relying on efficient low-level routines from external libraries where needed; \item the "FA$\mu$ST matrix multiplication" provides efficient linear operators to efficiently manipulate your data, relying on efficient low-level routines from external libraries where needed;
\item the "Factorization algorithms" is used to generate a FA$\mu$ST core from a dense matrix. \item the "Factorization algorithms" is used to generate a FA$\mu$ST core from a dense matrix.
\end{itemize} \end{itemize}
Various wrappers are planned to call \textrm{libfaust}. In the current version of \FAuST (Version 2.0), only the Matlab wrapper is implemented. Command-line, Python and A||GO wrapper are planned in the next version of FA$\mu$ST (see Section \ref{sec:WorkingProgress}). Various wrappers are planned to call \textrm{libfaust}. In the current version of \FAuST\ (Version 2.0), only the Matlab wrapper is implemented. Command-line, Python and A||GO wrapper are planned in the next version of FA$\mu$ST (see Section \ref{sec:WorkingProgress}).
\begin{figure}[H] %%[!htbp] \begin{figure}[H] %%[!htbp]
\centering \centering
\includegraphics[scale=0.45,trim = 0cm 5cm 0cm 4cm, clip]{images/FaustStructure.pdf} \includegraphics[scale=0.45,trim = 0cm 3cm 0cm 3cm, clip]{images/FaustStructure.pdf}
\caption{Brief structure of FA$\mu$ST version 2.0.0} \caption{Brief structure of FA$\mu$ST version 2.0.0}
\label{fig:faustStructure} \label{fig:faustStructure}
\end{figure} \end{figure}
\paragraph{Known issues} \paragraph{Known issues :}
\begin{enumerate} \begin{enumerate}
\item The installation on Windows using Visual Studio IDE has been tested with success in certain configurations, however \textbf{compilation problems have been encountered depending on the version of Windows and Visual Studio}. Unfortunately we cannot offer technical support but you may nevertheless report problems and/or suggestions on the mailing list \url{http://lists.gforge.inria.fr/pipermail/faust-install/}. \item The installation on Windows using Visual Studio IDE has been tested with success in certain configurations, however \textbf{compilation problems have been encountered depending on the version of Windows and Visual Studio}. Unfortunately we cannot offer technical support but you may nevertheless report problems and/or suggestions on the mailing list \url{http://lists.gforge.inria.fr/pipermail/faust-install/}.
...@@ -62,8 +62,8 @@ Various wrappers are planned to call \textrm{libfaust}. In the current version o ...@@ -62,8 +62,8 @@ Various wrappers are planned to call \textrm{libfaust}. In the current version o
\end{enumerate} \end{enumerate}
\paragraph{How do I pronounce \FAuST?} We suggest to pronounce the library name as ``FAUST'', but you may also pronounce it ``FAMUST'' ;-) \paragraph{How do I pronounce \FAuST\ ?} We suggest to pronounce the library name as ``FAUST'', but you may also pronounce it ``FAMUST'' ;-)
\paragraph{License:}Copyright (2016) Luc Le Magoarou, Remi Gribonval INRIA Rennes, FRANCE \\ \paragraph{License :}Copyright (2016) Luc Le Magoarou, Remi Gribonval INRIA Rennes, FRANCE \\
The FA$\mu$ST Toolbox is distributed under the terms of the GNU Affero General Public License. This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with this program. If not, see \url{http://www.gnu.org/licenses/}. The FA$\mu$ST Toolbox is distributed under the terms of the GNU Affero General Public License. This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with this program. If not, see \url{http://www.gnu.org/licenses/}.
No preview for this file type
...@@ -41,8 +41,9 @@ ROOT_DIR=[fileparts(mfilename('fullpath')),filesep]; ...@@ -41,8 +41,9 @@ ROOT_DIR=[fileparts(mfilename('fullpath')),filesep];
fprintf('Welcome to wrapper matlab C++ FAuST_toolbox. FAuST root directory is %s\n',ROOT_DIR); fprintf('Welcome to the Matlab wrapper of the FAuST C++ toolbox.');
fprintf('adding path %s\n and all its subdirectories ',ROOT_DIR); fprintf('FAuST root directory is %s\n',ROOT_DIR);
fprintf('Adding path %s\n and all its subdirectories ',ROOT_DIR);
addpath(genpath(ROOT_DIR)); addpath(genpath(ROOT_DIR));
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment