Changeset 6

Timestamp:

Feb 26, 2003, 5:43:54 PM (21 years ago)

Author:

Jari Häkkinen

Message:

* empty log message *

File:

• trunk/src/SVD.h (modified) (3 diffs)

trunk/src/SVD.h

@@ -4 +4 @@
 #define _THEP_CPPTOOLS_SVD_ 
 
-//GCLwrap includes
+//GSLwrap includes
 //////////////////
 #include <gslwrap/matrix_double.h>
@@ -26 +26 @@
 namespace THEP_CPPTOOLS
 {  
+
+    /**
+       Class encapsulating methods for Singular Value Decomposition
+
+       @version $Revision$ $Date$
+    */
+
   class SVD
   {    
@@ -40 +47 @@
   public:
     SVD();
+    /**
+       Constructs a SVD object and initializes it to proper matrix
+       sizes. The input matrix is copied for further use in the
+       object.
+    */
     SVD( const gsl::matrix& );
-    SVD( const gsl::matrix&, const gsl::vector& );
+    /**
+       Constructor initializing the SVD object for Solver.  Solver
+       requires an extra-vector paramter \a b: $Ax = b$ The $x$ vector
+       will be reached using the get_x() function.
+
+       @see get_x() function.
+    */
+    SVD( const gsl::matrix&, const gsl::vector& b);
     ~SVD();
     bool process( SVDtypes stype = Unmodified );