Changeset 1424 in Sophya

Timestamp:

Feb 23, 2001, 6:47:44 PM (25 years ago)

Author:

ansari

Message:

MAJ documentation - Reza 23/2/2001

Location:

trunk/SophyaExt

Files:

• IFFTW/fftwserver.cc (modified) (1 diff)
• LinAlg/intflapack.cc (modified) (5 diffs)
• LinAlg/intflapack.h (modified) (3 diffs)

trunk/SophyaExt/IFFTW/fftwserver.cc

@@ -2 +2 @@
 #include "FFTW/fftw.h"
 #include "FFTW/rfftw.h"
+
+/*!
+   \defgroup IFFTW IFFTW module
+   Module containing interface classes between Sophya objects
+   and FFTW Fourier transform package (see http://www.fftw.org )
+*/
 
 /*! 

trunk/SophyaExt/LinAlg/intflapack.cc

@@ -4 +4 @@
 #include "tmatrix.h"
 #include <typeinfo>
+
+/*!
+   \defgroup LinAlg LinAlg module
+   This module contains classes and functions for complex linear
+   algebra on arrays. This module is intended mainly to have 
+   classes implementing C++ interfaces between Sophya objects
+   and external linear algebra libraries, such as LAPACK.  
+*/
+
+/*! 
+  \class SOPHYA::LapackServer
+  \ingroup LinAlg
+  This class implements an interface to LAPACK library driver routines.
+  The LAPACK (Linear Algebra PACKage) is a collection high performance 
+  routines to solve common problems in numerical linear algebra. 
+  its is available from http://www.netlib.org.
+  
+  The present version of our LapackServer (Feb 2001) provides only 
+  interfaces for the linear system solver and singular value 
+  decomposition (SVD). Only arrays with BaseArray::FortranMemoryMapping 
+  can be handled by LapackServer. LapackServer can be instanciated 
+  for simple and double precision real or complex array types.
+
+  The example below shows solving a linear system A*X = B
+
+  \code
+  #include "intflapack.h"
+  // ...
+  // Use FortranMemoryMapping as default
+  BaseArray::SetDefaultMemoryMapping(BaseArray::FortranMemoryMapping);
+  // Create an fill the arrays A and B
+  int n = 20;
+  Matrix A(n, n);
+  A = RandomSequence();
+  Vector X(n),B(n);
+  X = RandomSequence();
+  B = A*X;
+  // Solve the linear system A*X = B
+  LapackServer<r_8> lps;
+  lps.LinSolve(A,B);
+  // We get the result in B, which should be equal to X ...
+  // Compute the difference B-X ;
+  Vector diff = B-X;
+  \endcode
+
+*/
 
 extern "C" {
@@ -46 +92 @@
 }
 
+//! Interface to Lapack linear system solver driver s/d/c/zgesvd().
+/*! Solve the linear system a * x = b. Input arrays
+  should have FortranMemory mapping (column packed).
+  \param a : input matrix, overwritten on output
+  \param b : input-output, input vector b, contains x on exit
+  \return : return code from lapack driver _gesv()
+ */
 template <class T>
 int LapackServer<T>::LinSolve(TArray<T>& a, TArray<T> & b)
@@ -91 +144 @@
 }
 
+//! Interface to Lapack SVD driver s/d/c/zgesv().
+/*! Computes the vector of singular values of \b a. Input arrays
+  should have FortranMemoryMapping (column packed).
+  \param a : input m-by-n matrix 
+  \param s : Vector of min(m,n) singular values (descending order)
+  \return : return code from lapack driver _gesvd()
+ */
+
 template <class T>
 int LapackServer<T>::SVD(TArray<T>& a, TArray<T> & s)
@@ -97 +158 @@
 }
 
+//! Interface to Lapack SVD driver s/d/c/zgesv().
+/*! Computes the vector of singular values of \b a, as well as
+  right and left singular vectors of \b a.
+  \f[
+  A = U \Sigma V^T , ( A = U \Sigma V^H \ complex)
+  \f]
+  \f[
+  A v_i = \sigma_i u_i \ and A^T u_i = \sigma_i v_i \ (A^H \ complex)
+  \f]
+  U and V are orthogonal (unitary) matrices.
+  \param a : input m-by-n matrix (in FotranMemoryMapping)
+  \param s : Vector of min(m,n) singular values (descending order)
+  \param u : Matrix of left singular vectors
+  \param vt : Transpose of right singular vectors.
+  \return : return code from lapack driver _gesvd()
+ */
 template <class T>
 int LapackServer<T>::SVD(TArray<T>& a, TArray<T> & s, TArray<T> & u, TArray<T> & vt)
@@ -103 +180 @@
 }
 
+
+//! Interface to Lapack SVD driver s/d/c/zgesv().
 template <class T>
 int LapackServer<T>::SVDDriver(TArray<T>& a, TArray<T> & s, TArray<T>* up, TArray<T>* vtp)

trunk/SophyaExt/LinAlg/intflapack.h

@@ -17 +17 @@
   virtual int SVD(TArray<T>& a, TArray<T> & s, TArray<T> & u, TArray<T> & vt); 
 
+  //! Set the workspace size factor for LAPACK routines
   inline void SetWorkSpaceSizeFactor(int f = 2)
   { wspace_size_factor = (f > 1) ? f : 1; }
+
+  //! Returns the workspace size factor
   inline int  GetWorkSpaceSizeFactor() 
   { return wspace_size_factor; }
@@ -29 +32 @@
 };
 
+/*! \ingroup LinAlg
+    \fn LapackLinSolve(TArray<T>&, TArray<T> &)
+    \brief Solves the linear system A*X = B using LapackServer. 
+*/
 template <class T>
 inline int LapackLinSolve(TArray<T>& a, TArray<T> & b)
 { LapackServer<T> lps; return( lps.LinSolve(a, b) );  }
 
+/*! \ingroup LinAlg
+    \fn LapackSVD(TArray<T>&, TArray<T> &)
+    \brief SVD decomposition using LapackServer. 
+*/
 template <class T>
 inline int LapackSVD(TArray<T>& a, TArray<T> & s)
 { LapackServer<T> lps; return( lps.SVD(a, s) ); }
 
+
+/*! \ingroup LinAlg
+    \fn LapackSVD(TArray<T>&, TArray<T> &, TArray<T> &, TArray<T> &)
+    \brief SVD decomposition using LapackServer. 
+*/
 template <class T>
 inline int LapackSVD(TArray<T>& a, TArray<T> & s, TArray<T> & u, TArray<T> & vt)
@@ -44 +60 @@
 } // Fin du namespace
 
-void rztest_lapack(TArray<r_4>& a, TArray<r_4>& b);
-
 #endif