Changeset 2084:59769591eb60 in lemon-0.x for lemon/matrix_maps.h

Timestamp:

05/15/06 11:49:51 (18 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

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

Message:

Documentation improvements

Rearrangements:

IO modules
Algorithms

New documentation:

SwapBpUGraphAdaptor

Demos:

strongly_connected_orientation.cc

Benchmarks:

swap_bipartite_bench.cc

File:

• lemon/matrix_maps.h (modified) (6 diffs)

lemon/matrix_maps.h

@@ -48 +48 @@
 
 
+    /// \brief Constructor of the row map
+    ///
+    /// Constructor of the row map.
     MatrixRowMap(MatrixMap& _matrix, typename MatrixMap::FirstKey _row) 
       : matrix(_matrix), row(_row) {}
@@ -92 +95 @@
 
 
+    /// \brief Constructor of the row map
+    ///
+    /// Constructor of the row map.
     ConstMatrixRowMap(const MatrixMap& _matrix, 
                       typename MatrixMap::FirstKey _row) 
@@ -109 +115 @@
   };
 
+  /// \ingroup matrices
+  ///
   /// \brief Gives back a row view of the matrix map
   ///
-  /// \ingroup matrices
   /// Gives back a row view of the matrix map.
   ///
+  /// \sa MatrixRowMap
+  /// \sa ConstMatrixRowMap
   template <typename MatrixMap>
   MatrixRowMap<MatrixMap> matrixRowMap(MatrixMap& matrixMap,
@@ -138 +147 @@
     typedef typename MatrixMap::Value Value;
 
+    /// \brief Constructor of the column map
+    ///
+    /// Constructor of the column map.
     MatrixColMap(MatrixMap& _matrix, typename MatrixMap::SecondKey _col) 
       : matrix(_matrix), col(_col) {}
@@ -181 +193 @@
     typedef typename MatrixMap::Value Value;
 
+    /// \brief Constructor of the column map
+    ///
+    /// Constructor of the column map.
     ConstMatrixColMap(const MatrixMap& _matrix, 
                       typename MatrixMap::SecondKey _col) 
@@ -198 +213 @@
   };
 
+  /// \ingroup matrices
+  ///
   /// \brief Gives back a column view of the matrix map
   ///
-  /// \ingroup matrices
   /// Gives back a column view of the matrix map.
   ///
+  /// \sa MatrixColMap
+  /// \sa ConstMatrixColMap
   template <typename MatrixMap>
   MatrixColMap<MatrixMap> matrixColMap(MatrixMap& matrixMap,