Changeset 2072:224d3781b00b in lemon-0.x

Timestamp:

05/09/06 11:21:48 (18 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2732

Message:

Create a separate group for matrices

Files:

• doc/groups.dox (modified) (1 diff)
• lemon/matrix_maps.h (modified) (14 diffs)

doc/groups.dox

@@ -83 +83 @@
 
 /**
+@defgroup matrices Matrices 
+@ingroup datas
+\brief Two dimensional data storages.
+
+Two dimensional
+data storages.
+*/
+
+
+/**
 @defgroup auxdat Auxiliary Data Structures
 @ingroup datas

lemon/matrix_maps.h

@@ -28 +28 @@
 
 /// \file
-/// \ingroup maps
+/// \ingroup matrices
 /// \brief Maps indexed with pairs of items.
 ///
@@ -37 +37 @@
   /// \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> {
@@ -79 +81 @@
   /// \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> {
@@ -107 +111 @@
   /// \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,
@@ -120 +126 @@
   }
 
-  /// \brief Map for the row view of the matrix
-  ///
-  /// 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.
+  ///
   template <typename _MatrixMap>
   class MatrixColMap : public MatrixMapTraits<_MatrixMap> {
@@ -161 +169 @@
   };
 
-  /// \brief Map for the col view of the matrix
-  ///
-  /// 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.
+  ///
   template <typename _MatrixMap>
   class ConstMatrixColMap : public MatrixMapTraits<_MatrixMap> {
@@ -188 +198 @@
   };
 
-  /// \brief Gives back a col view of the matrix map
-  ///
-  /// 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.
+  ///
   template <typename MatrixMap>
   MatrixColMap<MatrixMap> matrixColMap(MatrixMap& matrixMap,
@@ -205 +217 @@
   /// \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 
@@ -339 +352 @@
   /// \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 
@@ -389 +403 @@
     ///
     ///It allow to assign a map to an other.
+    ///
     DynamicSymMatrixMap& operator=(const DynamicSymMatrixMap& _cmap){
       return operator=<DynamicSymMatrixMap>(_cmap);
@@ -436 +451 @@
     ///
     /// Setter function for the matrix map.
+    ///
     void set(const Key& first, const Key& second, const Value& val) {
       values[index(Parent::getNotifier()->id(first), 
@@ -477 +493 @@
   ///\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
@@ -612 +629 @@
       ///The map type for it is linked.
       DynamicAsymMatrixMap& _owner;
-    };///END OF FIRSTKEYPROXY
+    };//END OF FIRSTKEYPROXY
       
       ///\brief Proxy class for the second key type.
@@ -698 +715 @@
       ///The type of map for which it is attached.
       DynamicAsymMatrixMap& _owner;
-    };///END OF SECONDKEYPROXY
+    };//END OF SECONDKEYPROXY
       
   private: