lemon/matrix_maps.h
changeset 2084 59769591eb60
parent 2072 224d3781b00b
child 2088 68f8d17ced51
     1.1 --- a/lemon/matrix_maps.h	Mon May 15 09:46:33 2006 +0000
     1.2 +++ b/lemon/matrix_maps.h	Mon May 15 09:49:51 2006 +0000
     1.3 @@ -47,6 +47,9 @@
     1.4      typedef typename MatrixMap::Value Value;
     1.5  
     1.6  
     1.7 +    /// \brief Constructor of the row map
     1.8 +    ///
     1.9 +    /// Constructor of the row map.
    1.10      MatrixRowMap(MatrixMap& _matrix, typename MatrixMap::FirstKey _row) 
    1.11        : matrix(_matrix), row(_row) {}
    1.12  
    1.13 @@ -91,6 +94,9 @@
    1.14      typedef typename MatrixMap::Value Value;
    1.15  
    1.16  
    1.17 +    /// \brief Constructor of the row map
    1.18 +    ///
    1.19 +    /// Constructor of the row map.
    1.20      ConstMatrixRowMap(const MatrixMap& _matrix, 
    1.21  		      typename MatrixMap::FirstKey _row) 
    1.22        : matrix(_matrix), row(_row) {}
    1.23 @@ -108,11 +114,14 @@
    1.24      typename MatrixMap::FirstKey row;
    1.25    };
    1.26  
    1.27 +  /// \ingroup matrices
    1.28 +  ///
    1.29    /// \brief Gives back a row view of the matrix map
    1.30    ///
    1.31 -  /// \ingroup matrices
    1.32    /// Gives back a row view of the matrix map.
    1.33    ///
    1.34 +  /// \sa MatrixRowMap
    1.35 +  /// \sa ConstMatrixRowMap
    1.36    template <typename MatrixMap>
    1.37    MatrixRowMap<MatrixMap> matrixRowMap(MatrixMap& matrixMap,
    1.38  				       typename MatrixMap::FirstKey row) {
    1.39 @@ -137,6 +146,9 @@
    1.40      typedef typename MatrixMap::FirstKey Key;
    1.41      typedef typename MatrixMap::Value Value;
    1.42  
    1.43 +    /// \brief Constructor of the column map
    1.44 +    ///
    1.45 +    /// Constructor of the column map.
    1.46      MatrixColMap(MatrixMap& _matrix, typename MatrixMap::SecondKey _col) 
    1.47        : matrix(_matrix), col(_col) {}
    1.48  
    1.49 @@ -180,6 +192,9 @@
    1.50      typedef typename MatrixMap::FirstKey Key;
    1.51      typedef typename MatrixMap::Value Value;
    1.52  
    1.53 +    /// \brief Constructor of the column map
    1.54 +    ///
    1.55 +    /// Constructor of the column map.
    1.56      ConstMatrixColMap(const MatrixMap& _matrix, 
    1.57  		      typename MatrixMap::SecondKey _col) 
    1.58        : matrix(_matrix), col(_col) {}
    1.59 @@ -197,11 +212,14 @@
    1.60      typename MatrixMap::SecondKey col;
    1.61    };
    1.62  
    1.63 +  /// \ingroup matrices
    1.64 +  ///
    1.65    /// \brief Gives back a column view of the matrix map
    1.66    ///
    1.67 -  /// \ingroup matrices
    1.68    /// Gives back a column view of the matrix map.
    1.69    ///
    1.70 +  /// \sa MatrixColMap
    1.71 +  /// \sa ConstMatrixColMap
    1.72    template <typename MatrixMap>
    1.73    MatrixColMap<MatrixMap> matrixColMap(MatrixMap& matrixMap,
    1.74  				       typename MatrixMap::SecondKey col) {