[Toon-members] TooN/doc LUdoc.h

[Tom Drummond]

CVSROOT:        /sources/toon
Module name:    TooN
Changes by:     Tom Drummond <twd20>    07/03/06 21:55:10

Modified files:
        doc            : LUdoc.h 

Log message:
        LU documentation fixed so it appears in the doxygen web pages

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/TooN/doc/LUdoc.h?cvsroot=toon&r1=1.3&r2=1.4

Patches:
Index: LUdoc.h
===================================================================
RCS file: /sources/toon/TooN/doc/LUdoc.h,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -b -r1.3 -r1.4
--- LUdoc.h     9 Jul 2006 19:55:26 -0000       1.3
+++ LUdoc.h     6 Mar 2007 21:55:10 -0000       1.4
@@ -25,32 +25,33 @@
 /// All classes and functions are within this namespace
 namespace TooN
 {
+/**
address@hidden LU LUdoc.h TooN/LU.h
+Performs %LU decomposition and back substitutes to solve equations.
+The %LU decomposition is the fastest way of solving the equation 
+\f$M\underline{x} = \underline{c}\f$m, but it becomes unstable when
+\f$M\f$ is (nearly) singular (in which cases the SymEigen or SVD decompositions
+are better). It decomposes a matrix \f$M\f$ into
+\f[M = L \times U\f]
+where \f$L\f$ is a lower-diagonal matrix with unit diagonal and \f$U\f$ is an 
+upper-diagonal matrix. The library only supports the decomposition of square 
matrices.
+It can be used as follows to solve the \f$M\underline{x} = \underline{c}\f$ 
problem as follows:
address@hidden
+// construct M
+double d1[][] = {{1,2,3},{4,5,6},{7,8,10}};
+Matrix<3> M(d1);
+// construct c
+Vector<3> c = 2,3,4;
+// create the LU decomposition of M
+LU<3> luM(M);
+// compute x = M^-1 * c
+Vector<3> x = luM.backsub(c);
address@hidden
+The convention LU<> (=LU<-1>) is used to create an LU decomposition whose size 
is 
+determined at runtime.
address@hidden gDecomps
+**/
 
-/// @class LU LUdoc.h TooN/LU.h
-/// Performs %LU decomposition and back substitutes to solve equations.
-/// The %LU decomposition is the fastest way of solving the equation 
-/// \f$M\underline{x} = \underline{c}\f$m, but it becomes unstable when
-/// \f$M\f$ is (nearly) singular (in which cases the SymEigen or SVD 
decompositions
-/// are better). It decomposes a matrix \f$M\f$ into
-/// \f[M = L \times U\f]
-/// where \f$L\f$ is a lower-diagonal matrix with unit diagonal and \f$U\f$ is 
an 
-/// upper-diagonal matrix. The library only supports the decomposition of 
square matrices.
-/// 
-/// It can be used as follows to solve the \f$M\underline{x} = 
\underline{c}\f$ problem as follows:
-/// @code
-/// // construct M
-/// double d1[][] = {{1,2,3},{4,5,6},{7,8,10}};
-/// Matrix<3> M(d1);
-/// // construct c
-/// Vector<3> c = 2,3,4;
-/// // create the LU decomposition of M
-/// LU<3> luM(M);
-/// // compute x = M^-1 * c
-/// Vector<3> x = luM.backsub(c);
-/// @endcode
-/// The convention LU<> (=LU<-1>) is used to create an LU decomposition whose 
size is 
-/// determined at runtime.
-/// @ingroup gDecomps
 template <int Size>
 class LU 
 {