lemon-0.x: comparison lemon/matrix

equal deleted inserted replaced

-:94b56ffc5738
+:bf96057988ec
 #include <lemon/maps.h>
 #include <lemon/concept/matrix_maps.h>
 /// \file
-/// \ingroup maps
+/// \ingroup matrices
 /// \brief Maps indexed with pairs of items.
 ///
 /// \todo This file has the same name as the concept file in concept/,
 ///  and this is not easily detectable in docs...
 namespace lemon {
 /// \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> {
 public:
 typedef _MatrixMap MatrixMap;
 typedef typename MatrixMap::SecondKey Key;
 typename MatrixMap::FirstKey row;
 };
 /// \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> {
 public:
 typedef _MatrixMap MatrixMap;
 typedef typename MatrixMap::SecondKey Key;
 typename MatrixMap::FirstKey row;
 };
 /// \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,
 				       typename MatrixMap::FirstKey row) {
 return MatrixRowMap<MatrixMap>(matrixMap, row);
 }
 ConstMatrixRowMap<MatrixMap>
 matrixRowMap(const MatrixMap& matrixMap, typename MatrixMap::FirstKey row) {
 return ConstMatrixRowMap<MatrixMap>(matrixMap, row);
 }
-/// \brief Map for the row view of the matrix
+/// \brief Map for the column view of the matrix
 ///
-/// Map for the row view of the matrix.
+/// \ingroup matrices
+/// Map for the column view of the matrix.
+///
 template <typename _MatrixMap>
 class MatrixColMap : public MatrixMapTraits<_MatrixMap> {
 public:
 typedef _MatrixMap MatrixMap;
 typedef typename MatrixMap::FirstKey Key;
 private:
 MatrixMap& matrix;
 typename MatrixMap::SecondKey col;
 };
-/// \brief Map for the col view of the matrix
+/// \brief Map for the column view of the matrix
 ///
-/// Map for the col view of the matrix.
+/// \ingroup matrices
+/// Map for the column view of the matrix.
+///
 template <typename _MatrixMap>
 class ConstMatrixColMap : public MatrixMapTraits<_MatrixMap> {
 public:
 typedef _MatrixMap MatrixMap;
 typedef typename MatrixMap::FirstKey Key;
 private:
 const MatrixMap& matrix;
 typename MatrixMap::SecondKey col;
 };
-/// \brief Gives back a col view of the matrix map
+/// \brief Gives back a column view of the matrix map
 ///
-/// Gives back a col view of the matrix map.
+/// \ingroup matrices
+/// Gives back a column view of the matrix map.
+///
 template <typename MatrixMap>
 MatrixColMap<MatrixMap> matrixColMap(MatrixMap& matrixMap,
 				       typename MatrixMap::SecondKey col) {
 return MatrixColMap<MatrixMap>(matrixMap, col);
 }
 return ConstMatrixColMap<MatrixMap>(matrixMap, col);
 }
 /// \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
 /// associated graph modified, so it updated automaticly whenever
 /// it is needed.
 template <typename _Graph, typename _Item, typename _Value>
 std::vector<Value> values;
 };
 /// \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
 /// associated graph modified, so it updated automaticly whenever
 /// it is needed.
 template <typename _Graph, typename _Item, typename _Value>
 ///\brief The assignement operator.
 ///
 ///It allow to assign a map to an other.
+///
 DynamicSymMatrixMap& operator=(const DynamicSymMatrixMap& _cmap){
 return operator=<DynamicSymMatrixMap>(_cmap);
 }
 ///\brief Template assignement operator.
 }
 /// \brief Setter function for the matrix map.
 ///
 /// Setter function for the matrix map.
+///
 void set(const Key& first, const Key& second, const Value& val) {
 values[index(Parent::getNotifier()->id(first),
 Parent::getNotifier()->id(second))] = val;
 }
 std::vector<Value> values;
 };
 ///\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
 ///data with different key types from different container types. It
 ///increases the size of the container if the linked containers
 ///content change, so it is updated automaticly whenever it is
 }
 private:
 ///The map type for it is linked.
 DynamicAsymMatrixMap& _owner;
-};///END OF FIRSTKEYPROXY
+};//END OF FIRSTKEYPROXY
 ///\brief Proxy class for the second key type.
 ///
 ///The proxy class belongs to the SecondKey type. It is
 ///necessary because if one want use the same conatainer types
 }
 private:
 ///The type of map for which it is attached.
 DynamicAsymMatrixMap& _owner;
-};///END OF SECONDKEYPROXY
+};//END OF SECONDKEYPROXY
 private:
 /// \e
 typedef std::vector<Value> Container;

changeset 2076	10681ee9d8ae
parent 2047	2b2ebca059ee
child 2084	59769591eb60