From 028527ebd4ddf83dd45db9c8e2a7863529a606d1 Mon Sep 17 00:00:00 2001 From: David Bellot Date: Tue, 15 Jun 2010 07:50:18 +0000 Subject: [PATCH] expression_types svn path=/branches/ublas-doxygen/; revision=62967 --- doxydoc.hpp | 6 +----- expression_types.hpp | 24 +++++++++++++++++------- 2 files changed, 18 insertions(+), 12 deletions(-) diff --git a/doxydoc.hpp b/doxydoc.hpp index f4973662..8b137891 100644 --- a/doxydoc.hpp +++ b/doxydoc.hpp @@ -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 my_4by4_matrix\encode defines a 4x4 double-precision matrix. You can also instantiate it directly with \code c_matrix 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. -/// + diff --git a/expression_types.hpp b/expression_types.hpp index 86241a9f..a1dbf507 100644 --- a/expression_types.hpp +++ b/expression_types.hpp @@ -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 ublas_expression { public: @@ -42,11 +47,16 @@ namespace boost { namespace numeric { namespace ublas { }; - // 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 scalar_expression: public ublas_expression {