1.1 --- a/doc/groups.dox Tue May 09 09:21:02 2006 +0000
1.2 +++ b/doc/groups.dox Tue May 09 09:21:48 2006 +0000
1.3 @@ -82,6 +82,16 @@
1.4 */
1.5
1.6 /**
1.7 +@defgroup matrices Matrices
1.8 +@ingroup datas
1.9 +\brief Two dimensional data storages.
1.10 +
1.11 +Two dimensional
1.12 +data storages.
1.13 +*/
1.14 +
1.15 +
1.16 +/**
1.17 @defgroup auxdat Auxiliary Data Structures
1.18 @ingroup datas
1.19 \brief Some data structures implemented in LEMON.
2.1 --- a/lemon/matrix_maps.h Tue May 09 09:21:02 2006 +0000
2.2 +++ b/lemon/matrix_maps.h Tue May 09 09:21:48 2006 +0000
2.3 @@ -27,7 +27,7 @@
2.4 #include <lemon/concept/matrix_maps.h>
2.5
2.6 /// \file
2.7 -/// \ingroup maps
2.8 +/// \ingroup matrices
2.9 /// \brief Maps indexed with pairs of items.
2.10 ///
2.11 /// \todo This file has the same name as the concept file in concept/,
2.12 @@ -36,7 +36,9 @@
2.13
2.14 /// \brief Map for the coloumn view of the matrix
2.15 ///
2.16 + /// \ingroup matrices
2.17 /// Map for the coloumn view of the matrix.
2.18 + ///
2.19 template <typename _MatrixMap>
2.20 class MatrixRowMap : public MatrixMapTraits<_MatrixMap> {
2.21 public:
2.22 @@ -78,7 +80,9 @@
2.23
2.24 /// \brief Map for the row view of the matrix
2.25 ///
2.26 + /// \ingroup matrices
2.27 /// Map for the row view of the matrix.
2.28 + ///
2.29 template <typename _MatrixMap>
2.30 class ConstMatrixRowMap : public MatrixMapTraits<_MatrixMap> {
2.31 public:
2.32 @@ -106,7 +110,9 @@
2.33
2.34 /// \brief Gives back a row view of the matrix map
2.35 ///
2.36 + /// \ingroup matrices
2.37 /// Gives back a row view of the matrix map.
2.38 + ///
2.39 template <typename MatrixMap>
2.40 MatrixRowMap<MatrixMap> matrixRowMap(MatrixMap& matrixMap,
2.41 typename MatrixMap::FirstKey row) {
2.42 @@ -119,9 +125,11 @@
2.43 return ConstMatrixRowMap<MatrixMap>(matrixMap, row);
2.44 }
2.45
2.46 - /// \brief Map for the row view of the matrix
2.47 + /// \brief Map for the column view of the matrix
2.48 ///
2.49 - /// Map for the row view of the matrix.
2.50 + /// \ingroup matrices
2.51 + /// Map for the column view of the matrix.
2.52 + ///
2.53 template <typename _MatrixMap>
2.54 class MatrixColMap : public MatrixMapTraits<_MatrixMap> {
2.55 public:
2.56 @@ -160,9 +168,11 @@
2.57 typename MatrixMap::SecondKey col;
2.58 };
2.59
2.60 - /// \brief Map for the col view of the matrix
2.61 + /// \brief Map for the column view of the matrix
2.62 ///
2.63 - /// Map for the col view of the matrix.
2.64 + /// \ingroup matrices
2.65 + /// Map for the column view of the matrix.
2.66 + ///
2.67 template <typename _MatrixMap>
2.68 class ConstMatrixColMap : public MatrixMapTraits<_MatrixMap> {
2.69 public:
2.70 @@ -187,9 +197,11 @@
2.71 typename MatrixMap::SecondKey col;
2.72 };
2.73
2.74 - /// \brief Gives back a col view of the matrix map
2.75 + /// \brief Gives back a column view of the matrix map
2.76 ///
2.77 - /// Gives back a col view of the matrix map.
2.78 + /// \ingroup matrices
2.79 + /// Gives back a column view of the matrix map.
2.80 + ///
2.81 template <typename MatrixMap>
2.82 MatrixColMap<MatrixMap> matrixColMap(MatrixMap& matrixMap,
2.83 typename MatrixMap::SecondKey col) {
2.84 @@ -204,6 +216,7 @@
2.85
2.86 /// \brief Container for store values for each ordered pair of graph items
2.87 ///
2.88 + /// \ingroup matrices
2.89 /// This data structure can strore for each pair of the same item
2.90 /// type a value. It increase the size of the container when the
2.91 /// associated graph modified, so it updated automaticly whenever
2.92 @@ -338,6 +351,7 @@
2.93
2.94 /// \brief Container for store values for each unordered pair of graph items
2.95 ///
2.96 + /// \ingroup matrices
2.97 /// This data structure can strore for each pair of the same item
2.98 /// type a value. It increase the size of the container when the
2.99 /// associated graph modified, so it updated automaticly whenever
2.100 @@ -388,6 +402,7 @@
2.101 ///\brief The assignement operator.
2.102 ///
2.103 ///It allow to assign a map to an other.
2.104 + ///
2.105 DynamicSymMatrixMap& operator=(const DynamicSymMatrixMap& _cmap){
2.106 return operator=<DynamicSymMatrixMap>(_cmap);
2.107 }
2.108 @@ -435,6 +450,7 @@
2.109 /// \brief Setter function for the matrix map.
2.110 ///
2.111 /// Setter function for the matrix map.
2.112 + ///
2.113 void set(const Key& first, const Key& second, const Value& val) {
2.114 values[index(Parent::getNotifier()->id(first),
2.115 Parent::getNotifier()->id(second))] = val;
2.116 @@ -476,6 +492,7 @@
2.117
2.118 ///\brief Dynamic Asymmetric Matrix Map.
2.119 ///
2.120 + ///\ingroup matrices
2.121 ///Dynamic Asymmetric Matrix Map. Container for store values for each
2.122 ///ordered pair of containers items. This data structure can store
2.123 ///data with different key types from different container types. It
2.124 @@ -611,7 +628,7 @@
2.125
2.126 ///The map type for it is linked.
2.127 DynamicAsymMatrixMap& _owner;
2.128 - };///END OF FIRSTKEYPROXY
2.129 + };//END OF FIRSTKEYPROXY
2.130
2.131 ///\brief Proxy class for the second key type.
2.132 ///
2.133 @@ -697,7 +714,7 @@
2.134
2.135 ///The type of map for which it is attached.
2.136 DynamicAsymMatrixMap& _owner;
2.137 - };///END OF SECONDKEYPROXY
2.138 + };//END OF SECONDKEYPROXY
2.139
2.140 private:
2.141