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

Subject: [Boost-commit] svn:boost r62967 - branches/ublas-doxygen
From: david.bellot_at_[hidden]
Date: 2010-06-15 03:50:19

Author: david.bellot
Date: 2010-06-15 03:50:18 EDT (Tue, 15 Jun 2010)
New Revision: 62967
URL: http://svn.boost.org/trac/boost/changeset/62967

Log:
expression_types

Text files modified: 
   branches/ublas-doxygen/doxydoc.hpp          |     6 +-----                                  
   branches/ublas-doxygen/expression_types.hpp |    24 +++++++++++++++++-------                
   2 files changed, 18 insertions(+), 12 deletions(-)

Modified: branches/ublas-doxygen/doxydoc.hpp
==============================================================================
--- branches/ublas-doxygen/doxydoc.hpp	(original)
+++ branches/ublas-doxygen/doxydoc.hpp	2010-06-15 03:50:18 EDT (Tue, 15 Jun 2010)
@@ -1,5 +1 @@
-///
-/// \class boost::numeric::ublas::c_vector
-/// \brief An array based vector class which size is defined at type specification or object instanciation.
-/// An array based matrix class which size is defined at type specification or object instanciation. This matrix is directly based on a predefinec C-style arry of data, thus providing the fastest implementation possible. The constraint is that dimensions of the matrix must be specified at the instanciation or the type specification. For instance, \code typedef c_matrix<double,4,4> my_4by4_matrix\encode defines a 4x4 double-precision matrix. You can also instantiate it directly with \code c_matrix<int,8,5> my_fast_matrix\endcode. This will make a 8 by 5 integer matrix. The price to pay for this speed is that you cannot resize it to a size larger than the one defined in the template parameters. In the previous example, a size of 4 by 5 or 3 by 2 is acceptable, but a new size of 9 by 5 or even 10 by 10 will raise a bad_size() exception.
-///
+

Modified: branches/ublas-doxygen/expression_types.hpp
==============================================================================
--- branches/ublas-doxygen/expression_types.hpp	(original)
+++ branches/ublas-doxygen/expression_types.hpp	2010-06-15 03:50:18 EDT (Tue, 15 Jun 2010)
@@ -22,8 +22,13 @@
 
 namespace boost { namespace numeric { namespace ublas {
 
-    // Base class for uBLAS staticaly derived expressions - see the Barton Nackman trick
-    //  Provides numeric properties for linear algebra
+    /** \brief Base class for uBLAS staticaly derived expressions using the the Barton Nackman trick
+     *
+     * This class provides the numeric properties for linear algebra.
+     * This is a NonAssignable class
+     * 
+     * \tparam E an expression type
+     */
     template<class E>
     class ublas_expression {
     public:
@@ -42,11 +47,16 @@
     };
 
 
-    // Base class for Scalar Expression models -
-    //  it does not model the Scalar Expression concept but all derived types should.
-    // The class defines a common base type and some common interface for all
-    // statically derived Scalar Expression classes
-    // We implement the casts to the statically derived type.
+    /** \bried Base class for Scalar Expression models
+     *
+     * It does not model the Scalar Expression concept but all derived types should.
+     * The class defines a common base type and some common interface for all statically 
+     * derived Scalar Expression classes.
+     *
+     * We implement the casts to the statically derived type.
+     *
+     * \tparam E an expression type
+     */
     template<class E>
     class scalar_expression:
         public ublas_expression<E> {