[Boost-commit] svn:boost r63324 - branches/ublas-doxygen

Subject: [Boost-commit] svn:boost r63324 - branches/ublas-doxygen
From: david.bellot_at_[hidden]
Date: 2010-06-25 15:17:59

Author: david.bellot
Date: 2010-06-25 15:17:58 EDT (Fri, 25 Jun 2010)
New Revision: 63324
URL: http://svn.boost.org/trac/boost/changeset/63324

Log:
adaptor (not yet finished in fact)

Text files modified: 
   branches/ublas-doxygen/banded.hpp |    13 ++++++++++++-                           
   1 files changed, 12 insertions(+), 1 deletions(-)

Modified: branches/ublas-doxygen/banded.hpp
==============================================================================
--- branches/ublas-doxygen/banded.hpp	(original)
+++ branches/ublas-doxygen/banded.hpp	2010-06-25 15:17:58 EDT (Fri, 25 Jun 2010)
@@ -1037,7 +1037,18 @@
         }
     };
 
-    // Banded matrix adaptor class
+    /** \brief A banded matrix adaptator: convert a matrix into a banded matrix
+     *
+     * For a \f$(mxn)\f$-dimensional banded matrix with \f$l\f$ lower and \f$u\f$ upper diagonals and 
+     * \f$0 \leq i < m\f$ and \f$0 \leq j < n\f$, if \f$i>j+l\f$ or \f$i<j-u\f$ then \f$b_{i,j}=0\f$. 
+     * The default storage for banded matrices is packed. Orientation and storage can also be specified. 
+     * Default is \c row_major and and unbounded_array. It is \b not required by the storage to initialize 
+     * elements of the matrix.
+     *
+     * \tparam T the type of object stored in the matrix (like double, float, complex, etc...)
+     * \tparam L the storage organization. It can be either \c row_major or \c column_major. Default is \c row_major
+     * \tparam A the type of Storage array. Default is \c unbounded_array
+     */
     template<class M>
     class banded_adaptor:
         public matrix_expression<banded_adaptor<M> > {