Commit a0a0c3a5 authored by PIACIBELLO Cyrille's avatar PIACIBELLO Cyrille

Documentation updated. Not finish yet.

parent f4315f51
......@@ -118,7 +118,7 @@ void ibgmresdr_set_rightprecond(Callback_RightCond rightPreCond,void * ptrRightP
* @param max_ite : iteration max to compute the solution
* @param restart : Maximum size allowed for Krylov Search Space.
* @param tolerance : in order to avoid producing an api function for
* each arithmetic, tolerance is passed as à generic ptr, and will be
* each arithmetic, tolerance is passed as a generic ptr, and will be
* cast then dereferenced by the library.
void ibgmresdr_set_parameters(int max_ite, int restart, void * tolerance,
......@@ -12,7 +12,24 @@ and Deflated restarting</i>, from E. Agullo, L. Giraud and Y-F Jing.
<a href="">Download</a>
\section prerequisite Prerequisites
\section descr Description
This library is sequential and support a classic BGMRes, and a BGMRes
with Inexact Breakdowns. It relies on Lapack and Blas kernels for the
computational part. A C Api is available (see Ib-GMRes-Dr.h).
This library does not implement the Matrix Product. Thus, the user
must provide to the library a Matrix x block of vector product. To
provide it, the user must pass it through a function pointer with the
C Api, or by providing a Matrix class similar to the one displayed and
used inside the examples provided. (testMatrixMarket ...).
\section qstart Quick Start
\subsection prerequisite Prerequisites
Required :
-# git.
......@@ -20,8 +37,7 @@ Required :
-# c/c++ compiler supporting c++11 standard.
-# Lapacke and cblas implementation.
\section qstart Quick Start
\subsection howTo How to build
How to build the library :
-# Create a build directory : <i> mkdir Build</i>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment