modif latex

gen_doc/LaTeX/annexes.tex

@@ -12,7 +12,7 @@ Here is a list of packages used in the FA$\mu$ST project. The installation of th
 \section{Compatibility between MATLAB and gcc compiler}\label{sec:ANNEXECompatibilityMatlabCompiler}
 Adjust your version of GCC compiler in order to run the installation properly. The use of the mex function in Matlab requires that you have a third-party compiler installed on your system. The latest version of Matlab (2016a in our case) only supports up to GCC 4.7 (see \url{http://fr.mathworks.com/support/compilers/R2016a/index.html?sec=glnxa64} for more detail).
 
-To temporally change your version of cc and cxx compiler, you can modify the environment variable CC an CXX. For that, export your CC and CXX variables corresponding to gcc and g++ binaries path :
+To temporally change your version of cc and cxx compiler, you can modify the environment variable CC and CXX. For that, export your CC and CXX variables corresponding to gcc and g++ binaries path :
 \begin{itemize}
 \item find your gcc and g++ version path using \texttt{which} command in a terminal :
 \lstset{style=customBash}
@@ -46,7 +46,7 @@ The command \textbf{make} will compile the build files.\\
 The command \textbf{sudo make install} will install the library and others components in the default directory: \\
 \texttt{/usr/local/lib/libfaust.a} for the FA$\mu$ST library, \\
 \texttt{\textasciitilde /Documents/MATLAB/faust/} for the wrapper matlab.\\
-You must have administrator privilege because the library file \texttt{libfaust.a} is copied in an root path directory. If you do not have administrator privilege, you can realize a local install using \texttt{cmake} optional parameter \texttt{-DCMAKE\_INSTALL\_PREFIX="<Your/Install/Dir>"}. 
+You must have administrator privilege because the library file \texttt{libfaust.a} is copied in a root path directory. If you do not have administrator privilege, you can realize a local install using \texttt{cmake} optional parameter \texttt{-DCMAKE\_INSTALL\_PREFIX="<Your/Install/Dir>"}. 
 
 The \texttt{cmake} optional parameter \texttt{-DCMAKE\_INSTALL\_PREFIX="<Your/Install/Dir>"} allows to install the binaries on the selected install directory. 
 
@@ -65,7 +65,7 @@ Here is a list of packages used in the FA$\mu$ST project. Eigen and OpenBlas lib
 \end{itemize}
 
 \section{Matlab and processor architecture}\label{sec:ANNEXEMatlabArch}
-If your processor architecture is 64 bit, Matlab must be installed in 64 bit. If your processor architecture is an 32 bit, Matlab must be installed in 32 bit. You can check your environment variable called PROCESSOR\_ARCHITECTURE by typing :
+If your processor architecture is 64 bit, Matlab must be installed in 64 bit. If your processor architecture is a 32 bit, Matlab must be installed in 32 bit. You can check your environment variable called PROCESSOR\_ARCHITECTURE by typing :
 \lstset{style=customBash}
 \begin{lstlisting}
 > set
@@ -119,7 +119,7 @@ You can generated the target using the terminal command \texttt{xcodebuild} :
 \section{Optional FAuST installation using GPU process}\label{sec:OptionalGPU}
 
 The toolbox FA$\mu$ST integrates optional Graphics Processing Unit (GPU) to improve its performances.
-\paragraph{Warning:} This optional GPU install has only be realized on an Linux machine. There is no guarantee that the installation and the use will be effective for every system.
+\paragraph{Warning:} This optional GPU install has only be realized on a Linux machine. There is no guarantee that the installation and the use will be effective for every system.
 
 \begin{itemize}
 \item \textbf{Install} the CUDA Toolkit and the drivers for NVIDIA.

gen_doc/LaTeX/chapInstallUnix.tex

 \chapter{Installation on Unix platform}\label{sec:InstallUnix}
 
-The FA$\mu$ST project is based on \textbf{C++ library} available for Linux, MAC OS X and Windows platforms. The proposed toolbox provides a Matlab wrapper. \textbf{CMake} has been chosen to build the FA$\mu$ST project because it is an open-source, cross-platform family of tools designed to build, test and package software. This chapter presents the steps to install the FA$\mu$ST tools on Unix platform (both Linux and Mac OS).\\
-\\
-Firstly, please ensure that the \textbf{prerequisite components} listed in Section \ref{sec:RequiredTools} are installed.
+The FA$\mu$ST project is available for Linux, MAC OS X and Windows platforms. The proposed toolbox provides a Matlab wrapper. \textbf{CMake} has been chosen to build the FA$\mu$ST project because it is an open-source, cross-platform family of tools designed to build, test and package software. This chapter presents the steps to install the FA$\mu$ST tools on Unix platform (both Linux and Mac OS).
 
-Secondly, refer to section \ref{sec:UnixBuildDownload} to download FA$\mu$ST package and setting your terminal. 
+\begin{enumerate}
+\item Ensure that the \textbf{prerequisite components} listed in Section \ref{sec:RequiredTools} are installed.
 
-Then refer to the appropriate section following the use (or not) of an IDE (Integrated Development Environment): 
+\item Refer to section \ref{sec:UnixBuildDownload} to download FA$\mu$ST package and setting your terminal. 
+
+\item Refer to the appropriate section following the use (or not) of an IDE (Integrated Development Environment): 
 \begin{itemize}
 \item Basic installation using \textbf{the command line terminal}, refer to Section \ref{sec:UnixBuildInstall}.
 \item Basic installation using \textbf{the IDE "Code::Blocks"}, refer to Section \ref{sec:UnixInstallCodeBlock}. 
 \item Basic installation using \textbf{the IDE "Xcode"} only for MAC OS X platform, refer to Section \ref{sec:MacInstallXcode}. 
 \end{itemize}
+\end{enumerate}
+
+Section \ref{sec:UnixCustomInstall} describes the custom options available to build the FA$\mu$ST toolbox, to propose a Custom - Advanced installation. For example, the optional configuration can be used to modify the install directory path, or to build in debug mode.  
 
-Finally in Section \ref{sec:UnixCustomInstall}, the custom options available to build the FA$\mu$ST toolbox are described to propose Custom - Advanced installation. For example, the optional configuration can be used to modify the install directory path, or to build in debug mode.  
 
 \lstset{style=customBash}
 \begin{lstlisting}
 > This kind of script represents the text command you must 
-> entered in an terminal command. For example : 
+> entered in a terminal command. For example : 
 > mkdir BUILD 
 \end{lstlisting}
 \lstset{style=customBash}
 \begin{lstlisting}
 when character '>' is missing in the beginning of each line,
-it signifies that the message is an return text in your
+it signifies that the message is a return text in your
 current terminal. 
 \end{lstlisting}
 \lstset{style=customMatlab}

gen_doc/LaTeX/chapInstallWindows.tex

 \chapter{Installation on Windows platform}\label{sec:WinInstall}
 
 
-The FA$\mu$ST project is based on \textbf{C++ library} available for Linux, MAC OS X and Windows platforms. The proposed toolbox provides a Matlab wrapper. \textbf{CMake} has been chosen to build the FA$\mu$ST project because it is an open-source, cross-platform family of tools designed to build, test and package software. This chapter presents the steps to install the FA$\mu$ST tools on Windows platform.
+The FA$\mu$ST project is available for Linux, MAC OS X and Windows platforms. The proposed toolbox provides a Matlab wrapper. \textbf{CMake} has been chosen to build the FA$\mu$ST project because it is an open-source, cross-platform family of tools designed to build, test and package software. This chapter presents the steps to install the FA$\mu$ST tools on Windows platform.
 
-\begin{itemize}
-\item Firstly, please ensure that the \textbf{prerequisite components} listed in Section \ref{sec:WinRequired} are installed. 
+\begin{enumerate}
+\item Ensure that the \textbf{prerequisite components} listed in Section \ref{sec:WinRequired} are installed. 
 
-\item Secondly, \textbf{choose your preferred C++ Compiler} between GCC from MinGW "Minimalist GNU for Windows"(Section \ref{sec:WinInstallMinGW}) and the C++ Compiler from Microsoft Visual Studio (Section \ref{sec:WinInstallVS}). 
+\item \textbf{Choose your preferred C++ Compiler} between GCC from MinGW "Minimalist GNU for Windows"(Section \ref{sec:WinInstallMinGW}) and the C++ Compiler from Microsoft Visual Studio (Section \ref{sec:WinInstallVS}). 
 
-\item Then, \textbf{process to Basic installation} of FA$\mu$ST tool by following instructions given in the appropriate section, depending to the kind of compiler (MinGW or Microsoft Visual) and the use (or not) of an IDE (Integrated Development Environment). 
-\end{itemize}
+\item \textbf{Process to Basic installation} of FA$\mu$ST tool by following instructions given in the appropriate section, depending to the kind of compiler (MinGW or Microsoft Visual) and the use (or not) of an IDE (Integrated Development Environment). 
+\end{enumerate}
 
 Section \ref{sec:WinCustomInstall} describes the custom options available to build the FA$\mu$ST toolbox, to propose Custom - Advanced installation. For example, the optional configuration can be used to modify the install directory path, or to build in debug mode.  
 
-
 \lstset{style=customBash}
 \begin{lstlisting}
 > This kind of script represents the text command you must 
-> entered in an terminal command. For example : 
+> entered in a terminal command. For example : 
 > mkdir BUILD 
 \end{lstlisting}
 \lstset{style=customBash}
 \begin{lstlisting}
 when character '>' is missing in the beginning of each line,
-it signifies that the message is an return text in your
+it signifies that the message is a return text in your
 current terminal. 
 \end{lstlisting}
 \lstset{style=customMatlab}

gen_doc/LaTeX/chapIntroduction.tex

 \chapter{Introduction}\label{sec:intro}
 
-\paragraph{Presentation:}FA$\mu$ST is a C++ toolbox, useful to decompose a given dense matrix into a product of sparse matrices in order to reduce its computational complexity (both for storage and manipulation). In Figure \ref{fig:presentation}, the matrix \textbf{A} represents the dense matrix and $\mathbf{S_j}$ correspond to the sparse matrices as $\mathbf{A}=\prod_{j=1}^J\mathbf{S_j}$.
+\paragraph{What is the use of that?}FA$\mu$ST is a C++ toolbox, useful to decompose a given dense matrix into a product of sparse matrices in order to reduce its computational complexity (both for storage and manipulation). In Figure \ref{fig:presentation}, the matrix \textbf{A} represents the dense matrix and $\mathbf{S_j}$ correspond to the sparse matrices as $\mathbf{A}=\prod_{j=1}^J\mathbf{S_j}$.
 
 \begin{figure}[H] %%[!htbp]
 \centering
@@ -16,12 +16,20 @@ For more information on the FAuST project, please visit the website of the proje
 %\paragraph{Brief description:} 
 %$A=\prod_{j=1}^J S_j$.
 
+%Valid Installation: Platforms, Compiler and IDE
+\paragraph{Which type of Platform and Compiler for the installation?} 
+The Figure \ref{fig:recapInstall} summarizes the tested configurations of the installation of the FA$\mu$ST toolbox following the type of platform (Linux, Mac or Windows), compiler, version of Matlab and the type of Integrate Development Environment (IDE).\\
+Choose among this Figure \ref{fig:recapInstall} the adapted platform and IDE following your system and refer to the corresponding Install Chapter. Authors suggest the installation using the GCC or Clang compiler directly from a command terminal because it is more simple and requires fewer externals components. 
 
-\paragraph{License:}Copyright (2016) Luc Le Magoarou, Remi Gribonval INRIA Rennes, FRANCE \\
-The FAuST 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/}.
+\begin{figure}[H] %%[!htbp]
+\centering
+\includegraphics[scale=0.4]{images/recapInstall.pdf}
+\caption{Checked Installation: Platforms and IDE}
+\label{fig:recapInstall}
+\end{figure}
 
-\paragraph{FA$\mu$ST Structure:}
-The Figure \ref{fig:faustStructure} presents an brief structure of the FA$\mu$ST toolbox. The principal C++ library called "libfaust" includes two components: the "Factorization algorithms" is used to generate a FA$\mu$ST core from a dense matrix and the "FA$\mu$ST matrix multiplication" provides the linear operator to manipulate your data. It can be employ using different types of wrappers but in the second version of FA$\mu$ST package (Version 2.0), only Matlab wrapper is provided. 
+\paragraph{How FA$\mu$ST is structured?}
+The Figure \ref{fig:faustStructure} presents a brief structure of the FA$\mu$ST toolbox. The principal C++ library called "libfaust" includes two components: the "Factorization algorithms" is used to generate a FA$\mu$ST core from a dense matrix and the "FA$\mu$ST matrix multiplication" provides the linear operator to manipulate your data. It can be employ using different types of wrappers but in the second version of FA$\mu$ST package (Version 2.0), only Matlab wrapper is provided. 
 
 
 \begin{figure}[H] %%[!htbp]
@@ -31,19 +39,14 @@ The Figure \ref{fig:faustStructure} presents an brief structure of the FA$\mu$ST
 \label{fig:faustStructure}
 \end{figure}
 
+\paragraph{Known problem:}
+\begin{enumerate}
+\item The installation on Windows Platform using Visual Studio IDE has been tested but there is compilation problems depending on the version of your Windows and your Visual Studio. \textbf{This install configuration is not guaranteed} but you can try and report any problem and/or suggestion on install-list of FA$\mu$ST project on \url{http://lists.gforge.inria.fr/pipermail/faust-install/}. 
+\item The "Factorization algorithms" module represented on Figure \ref{fig:faustStructure} is actually in progress (see Section). 
+\end{enumerate}
 
-\paragraph{Valid Installation: Platforms, Compiler and IDE}
-The Figure \ref{fig:recapInstall} summarizes the tested configurations of the installation of the FA$\mu$ST toolbox following the type of platform (Linux, Mac or Windows), compiler, version of Matlab and the type of Integrate Development Environment (IDE).\\
-Choose among this Figure \ref{fig:recapInstall} the adapted platform and IDE following your system and refer to the corresponding Install Chapter. Authors suggest the installation using the GCC or Clang compiler directly from a command terminal because it is more simple and requires fewer externals components. 
-
-The installation on Windows Platform using Visual Studio IDE has been tested but there is compilation problems depending of the version of your Windows and your Visual Studio. \textbf{This install configuration is not guaranteed} but you can try and report any problem and/or suggestion on install-list of FA$\mu$ST project on \url{http://lists.gforge.inria.fr/pipermail/faust-install/}. 
-
-\begin{figure}[H] %%[!htbp]
-\centering
-\includegraphics[scale=0.4]{images/recapInstall.pdf}
-\caption{Checked Installation: Platforms and IDE}
-\label{fig:recapInstall}
-\end{figure}
 
+\paragraph{Organization:}Chapter \ref{sec:InstallUnix} explains how to install the library FA$\mu$ST for UNIX (including Linux and Mac OS X) platform  and Chapter \ref{sec:WinInstall} corresponds to the Windows installation. Chapter \ref{sec:firstUse} shows quickly how to use this library and finally an example is given Chapter \ref{sec:example}. 
 
-\paragraph{Organization:}Chapter \ref{sec:InstallUnix} explains how to install the library FA$\mu$ST for UNIX platform and Chapter \ref{sec:WinInstall} corresponds to the Windows installation. Chapter \ref{sec:firstUse} shows quickly how to use this library and finally an example is given Chapter \ref{sec:example}. 
+\paragraph{License:}Copyright (2016) Luc Le Magoarou, Remi Gribonval INRIA Rennes, FRANCE \\
+The FAuST 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/}.

gen_doc/LaTeX/getting-started-with-faust-toolbox.tex

@@ -35,7 +35,7 @@
 
 \hypersetup{
 	colorlinks=true, 
-	linkcolor=red, % color of internal links (change box color with linkbordercolor)
+	linkcolor=black, % color of internal links (change box color with linkbordercolor)
     citecolor=green,        % color of links to bibliography
     filecolor=magenta,      % color of file links
     urlcolor=blue