[Lemon-commits] [lemon_svn] alpar: r2732 - in hugo/trunk: doc lemon

[Lemon SVN]

Author: alpar
Date: Tue May  9 11:21:48 2006
New Revision: 2732

Modified:
   hugo/trunk/doc/groups.dox
   hugo/trunk/lemon/matrix_maps.h

Log:
Create a separate group for matrices

Modified: hugo/trunk/doc/groups.dox
==============================================================================
--- hugo/trunk/doc/groups.dox	(original)
+++ hugo/trunk/doc/groups.dox	Tue May  9 11:21:48 2006
@@ -82,6 +82,16 @@
 */
 
 /**
+ at defgroup matrices Matrices 
+ at ingroup datas
+\brief Two dimensional data storages.
+
+Two dimensional
+data storages.
+*/
+
+
+/**
 @defgroup auxdat Auxiliary Data Structures
 @ingroup datas
 \brief Some data structures implemented in LEMON.

Modified: hugo/trunk/lemon/matrix_maps.h
==============================================================================
--- hugo/trunk/lemon/matrix_maps.h	(original)
+++ hugo/trunk/lemon/matrix_maps.h	Tue May  9 11:21:48 2006
@@ -27,7 +27,7 @@
 #include <lemon/concept/matrix_maps.h>
 
 /// \file
-/// \ingroup maps
+/// \ingroup matrices
 /// \brief Maps indexed with pairs of items.
 ///
 /// \todo This file has the same name as the concept file in concept/,
@@ -36,7 +36,9 @@
 
   /// \brief Map for the coloumn view of the matrix
   ///
+  /// \ingroup matrices
   /// Map for the coloumn view of the matrix.
+  ///
   template <typename _MatrixMap>
   class MatrixRowMap : public MatrixMapTraits<_MatrixMap> {
   public:
@@ -78,7 +80,9 @@
 
   /// \brief Map for the row view of the matrix
   ///
+  /// \ingroup matrices
   /// Map for the row view of the matrix.
+  ///
   template <typename _MatrixMap>
   class ConstMatrixRowMap : public MatrixMapTraits<_MatrixMap> {
   public:
@@ -106,7 +110,9 @@
 
   /// \brief Gives back a row view of the matrix map
   ///
+  /// \ingroup matrices
   /// Gives back a row view of the matrix map.
+  ///
   template <typename MatrixMap>
   MatrixRowMap<MatrixMap> matrixRowMap(MatrixMap& matrixMap,
 				       typename MatrixMap::FirstKey row) {
@@ -119,9 +125,11 @@
     return ConstMatrixRowMap<MatrixMap>(matrixMap, row);
   }
 
-  /// \brief Map for the row view of the matrix
+  /// \brief Map for the column view of the matrix
+  ///
+  /// \ingroup matrices
+  /// Map for the column view of the matrix.
   ///
-  /// Map for the row view of the matrix.
   template <typename _MatrixMap>
   class MatrixColMap : public MatrixMapTraits<_MatrixMap> {
   public:
@@ -160,9 +168,11 @@
     typename MatrixMap::SecondKey col;
   };
 
-  /// \brief Map for the col view of the matrix
+  /// \brief Map for the column view of the matrix
+  ///
+  /// \ingroup matrices
+  /// Map for the column view of the matrix.
   ///
-  /// Map for the col view of the matrix.
   template <typename _MatrixMap>
   class ConstMatrixColMap : public MatrixMapTraits<_MatrixMap> {
   public:
@@ -187,9 +197,11 @@
     typename MatrixMap::SecondKey col;
   };
 
-  /// \brief Gives back a col view of the matrix map
+  /// \brief Gives back a column view of the matrix map
+  ///
+  /// \ingroup matrices
+  /// Gives back a column view of the matrix map.
   ///
-  /// Gives back a col view of the matrix map.
   template <typename MatrixMap>
   MatrixColMap<MatrixMap> matrixColMap(MatrixMap& matrixMap,
 				       typename MatrixMap::SecondKey col) {
@@ -204,6 +216,7 @@
 
   /// \brief Container for store values for each ordered pair of graph items
   ///
+  /// \ingroup matrices
   /// This data structure can strore for each pair of the same item
   /// type a value. It increase the size of the container when the 
   /// associated graph modified, so it updated automaticly whenever
@@ -338,6 +351,7 @@
 
   /// \brief Container for store values for each unordered pair of graph items
   ///
+  /// \ingroup matrices
   /// This data structure can strore for each pair of the same item
   /// type a value. It increase the size of the container when the 
   /// associated graph modified, so it updated automaticly whenever
@@ -388,6 +402,7 @@
     ///\brief The assignement operator.
     ///
     ///It allow to assign a map to an other.
+    ///
     DynamicSymMatrixMap& operator=(const DynamicSymMatrixMap& _cmap){
       return operator=<DynamicSymMatrixMap>(_cmap);
     }
@@ -435,6 +450,7 @@
     /// \brief Setter function for the matrix map.
     ///
     /// Setter function for the matrix map.
+    ///
     void set(const Key& first, const Key& second, const Value& val) {
       values[index(Parent::getNotifier()->id(first), 
                    Parent::getNotifier()->id(second))] = val;
@@ -476,6 +492,7 @@
   
   ///\brief Dynamic Asymmetric Matrix Map.
   ///
+  ///\ingroup matrices
   ///Dynamic Asymmetric Matrix Map.  Container for store values for each
   ///ordered pair of containers items.  This data structure can store
   ///data with different key types from different container types. It
@@ -611,7 +628,7 @@
           
       ///The map type for it is linked.
       DynamicAsymMatrixMap& _owner;
-    };///END OF FIRSTKEYPROXY
+    };//END OF FIRSTKEYPROXY
       
       ///\brief Proxy class for the second key type.
       ///
@@ -697,7 +714,7 @@
           
       ///The type of map for which it is attached.
       DynamicAsymMatrixMap& _owner;
-    };///END OF SECONDKEYPROXY
+    };//END OF SECONDKEYPROXY
       
   private: