1.1 --- a/lemon/matrix_maps.h Tue May 09 09:21:02 2006 +0000
1.2 +++ b/lemon/matrix_maps.h Tue May 09 09:21:48 2006 +0000
1.3 @@ -27,7 +27,7 @@
1.4 #include <lemon/concept/matrix_maps.h>
1.5
1.6 /// \file
1.7 -/// \ingroup maps
1.8 +/// \ingroup matrices
1.9 /// \brief Maps indexed with pairs of items.
1.10 ///
1.11 /// \todo This file has the same name as the concept file in concept/,
1.12 @@ -36,7 +36,9 @@
1.13
1.14 /// \brief Map for the coloumn view of the matrix
1.15 ///
1.16 + /// \ingroup matrices
1.17 /// Map for the coloumn view of the matrix.
1.18 + ///
1.19 template <typename _MatrixMap>
1.20 class MatrixRowMap : public MatrixMapTraits<_MatrixMap> {
1.21 public:
1.22 @@ -78,7 +80,9 @@
1.23
1.24 /// \brief Map for the row view of the matrix
1.25 ///
1.26 + /// \ingroup matrices
1.27 /// Map for the row view of the matrix.
1.28 + ///
1.29 template <typename _MatrixMap>
1.30 class ConstMatrixRowMap : public MatrixMapTraits<_MatrixMap> {
1.31 public:
1.32 @@ -106,7 +110,9 @@
1.33
1.34 /// \brief Gives back a row view of the matrix map
1.35 ///
1.36 + /// \ingroup matrices
1.37 /// Gives back a row view of the matrix map.
1.38 + ///
1.39 template <typename MatrixMap>
1.40 MatrixRowMap<MatrixMap> matrixRowMap(MatrixMap& matrixMap,
1.41 typename MatrixMap::FirstKey row) {
1.42 @@ -119,9 +125,11 @@
1.43 return ConstMatrixRowMap<MatrixMap>(matrixMap, row);
1.44 }
1.45
1.46 - /// \brief Map for the row view of the matrix
1.47 + /// \brief Map for the column view of the matrix
1.48 ///
1.49 - /// Map for the row view of the matrix.
1.50 + /// \ingroup matrices
1.51 + /// Map for the column view of the matrix.
1.52 + ///
1.53 template <typename _MatrixMap>
1.54 class MatrixColMap : public MatrixMapTraits<_MatrixMap> {
1.55 public:
1.56 @@ -160,9 +168,11 @@
1.57 typename MatrixMap::SecondKey col;
1.58 };
1.59
1.60 - /// \brief Map for the col view of the matrix
1.61 + /// \brief Map for the column view of the matrix
1.62 ///
1.63 - /// Map for the col view of the matrix.
1.64 + /// \ingroup matrices
1.65 + /// Map for the column view of the matrix.
1.66 + ///
1.67 template <typename _MatrixMap>
1.68 class ConstMatrixColMap : public MatrixMapTraits<_MatrixMap> {
1.69 public:
1.70 @@ -187,9 +197,11 @@
1.71 typename MatrixMap::SecondKey col;
1.72 };
1.73
1.74 - /// \brief Gives back a col view of the matrix map
1.75 + /// \brief Gives back a column view of the matrix map
1.76 ///
1.77 - /// Gives back a col view of the matrix map.
1.78 + /// \ingroup matrices
1.79 + /// Gives back a column view of the matrix map.
1.80 + ///
1.81 template <typename MatrixMap>
1.82 MatrixColMap<MatrixMap> matrixColMap(MatrixMap& matrixMap,
1.83 typename MatrixMap::SecondKey col) {
1.84 @@ -204,6 +216,7 @@
1.85
1.86 /// \brief Container for store values for each ordered pair of graph items
1.87 ///
1.88 + /// \ingroup matrices
1.89 /// This data structure can strore for each pair of the same item
1.90 /// type a value. It increase the size of the container when the
1.91 /// associated graph modified, so it updated automaticly whenever
1.92 @@ -338,6 +351,7 @@
1.93
1.94 /// \brief Container for store values for each unordered pair of graph items
1.95 ///
1.96 + /// \ingroup matrices
1.97 /// This data structure can strore for each pair of the same item
1.98 /// type a value. It increase the size of the container when the
1.99 /// associated graph modified, so it updated automaticly whenever
1.100 @@ -388,6 +402,7 @@
1.101 ///\brief The assignement operator.
1.102 ///
1.103 ///It allow to assign a map to an other.
1.104 + ///
1.105 DynamicSymMatrixMap& operator=(const DynamicSymMatrixMap& _cmap){
1.106 return operator=<DynamicSymMatrixMap>(_cmap);
1.107 }
1.108 @@ -435,6 +450,7 @@
1.109 /// \brief Setter function for the matrix map.
1.110 ///
1.111 /// Setter function for the matrix map.
1.112 + ///
1.113 void set(const Key& first, const Key& second, const Value& val) {
1.114 values[index(Parent::getNotifier()->id(first),
1.115 Parent::getNotifier()->id(second))] = val;
1.116 @@ -476,6 +492,7 @@
1.117
1.118 ///\brief Dynamic Asymmetric Matrix Map.
1.119 ///
1.120 + ///\ingroup matrices
1.121 ///Dynamic Asymmetric Matrix Map. Container for store values for each
1.122 ///ordered pair of containers items. This data structure can store
1.123 ///data with different key types from different container types. It
1.124 @@ -611,7 +628,7 @@
1.125
1.126 ///The map type for it is linked.
1.127 DynamicAsymMatrixMap& _owner;
1.128 - };///END OF FIRSTKEYPROXY
1.129 + };//END OF FIRSTKEYPROXY
1.130
1.131 ///\brief Proxy class for the second key type.
1.132 ///
1.133 @@ -697,7 +714,7 @@
1.134
1.135 ///The type of map for which it is attached.
1.136 DynamicAsymMatrixMap& _owner;
1.137 - };///END OF SECONDKEYPROXY
1.138 + };//END OF SECONDKEYPROXY
1.139
1.140 private:
1.141