Changeset 1424 in Sophya for trunk/SophyaExt/LinAlg/intflapack.h

Timestamp:

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

Author:

ansari

Message:

MAJ documentation - Reza 23/2/2001

File:

• trunk/SophyaExt/LinAlg/intflapack.h (modified) (3 diffs)

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