COIN-OR::LEMON - Graph Library

Changeset 2072:224d3781b00b in lemon-0.x


Ignore:
Timestamp:
05/09/06 11:21:48 (18 years ago)
Author:
Alpar Juttner
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2732
Message:

Create a separate group for matrices

Files:
2 edited

Legend:

Unmodified
Added
Removed
  • doc/groups.dox

    r2060 r2072  
    8383
    8484/**
     85@defgroup matrices Matrices
     86@ingroup datas
     87\brief Two dimensional data storages.
     88
     89Two dimensional
     90data storages.
     91*/
     92
     93
     94/**
    8595@defgroup auxdat Auxiliary Data Structures
    8696@ingroup datas
  • lemon/matrix_maps.h

    r2047 r2072  
    2828
    2929/// \file
    30 /// \ingroup maps
     30/// \ingroup matrices
    3131/// \brief Maps indexed with pairs of items.
    3232///
     
    3737  /// \brief Map for the coloumn view of the matrix
    3838  ///
     39  /// \ingroup matrices
    3940  /// Map for the coloumn view of the matrix.
     41  ///
    4042  template <typename _MatrixMap>
    4143  class MatrixRowMap : public MatrixMapTraits<_MatrixMap> {
     
    7981  /// \brief Map for the row view of the matrix
    8082  ///
     83  /// \ingroup matrices
    8184  /// Map for the row view of the matrix.
     85  ///
    8286  template <typename _MatrixMap>
    8387  class ConstMatrixRowMap : public MatrixMapTraits<_MatrixMap> {
     
    107111  /// \brief Gives back a row view of the matrix map
    108112  ///
     113  /// \ingroup matrices
    109114  /// Gives back a row view of the matrix map.
     115  ///
    110116  template <typename MatrixMap>
    111117  MatrixRowMap<MatrixMap> matrixRowMap(MatrixMap& matrixMap,
     
    120126  }
    121127
    122   /// \brief Map for the row view of the matrix
    123   ///
    124   /// Map for the row view of the matrix.
     128  /// \brief Map for the column view of the matrix
     129  ///
     130  /// \ingroup matrices
     131  /// Map for the column view of the matrix.
     132  ///
    125133  template <typename _MatrixMap>
    126134  class MatrixColMap : public MatrixMapTraits<_MatrixMap> {
     
    161169  };
    162170
    163   /// \brief Map for the col view of the matrix
    164   ///
    165   /// Map for the col view of the matrix.
     171  /// \brief Map for the column view of the matrix
     172  ///
     173  /// \ingroup matrices
     174  /// Map for the column view of the matrix.
     175  ///
    166176  template <typename _MatrixMap>
    167177  class ConstMatrixColMap : public MatrixMapTraits<_MatrixMap> {
     
    188198  };
    189199
    190   /// \brief Gives back a col view of the matrix map
    191   ///
    192   /// Gives back a col view of the matrix map.
     200  /// \brief Gives back a column view of the matrix map
     201  ///
     202  /// \ingroup matrices
     203  /// Gives back a column view of the matrix map.
     204  ///
    193205  template <typename MatrixMap>
    194206  MatrixColMap<MatrixMap> matrixColMap(MatrixMap& matrixMap,
     
    205217  /// \brief Container for store values for each ordered pair of graph items
    206218  ///
     219  /// \ingroup matrices
    207220  /// This data structure can strore for each pair of the same item
    208221  /// type a value. It increase the size of the container when the
     
    339352  /// \brief Container for store values for each unordered pair of graph items
    340353  ///
     354  /// \ingroup matrices
    341355  /// This data structure can strore for each pair of the same item
    342356  /// type a value. It increase the size of the container when the
     
    389403    ///
    390404    ///It allow to assign a map to an other.
     405    ///
    391406    DynamicSymMatrixMap& operator=(const DynamicSymMatrixMap& _cmap){
    392407      return operator=<DynamicSymMatrixMap>(_cmap);
     
    436451    ///
    437452    /// Setter function for the matrix map.
     453    ///
    438454    void set(const Key& first, const Key& second, const Value& val) {
    439455      values[index(Parent::getNotifier()->id(first),
     
    477493  ///\brief Dynamic Asymmetric Matrix Map.
    478494  ///
     495  ///\ingroup matrices
    479496  ///Dynamic Asymmetric Matrix Map.  Container for store values for each
    480497  ///ordered pair of containers items.  This data structure can store
     
    612629      ///The map type for it is linked.
    613630      DynamicAsymMatrixMap& _owner;
    614     };///END OF FIRSTKEYPROXY
     631    };//END OF FIRSTKEYPROXY
    615632     
    616633      ///\brief Proxy class for the second key type.
     
    698715      ///The type of map for which it is attached.
    699716      DynamicAsymMatrixMap& _owner;
    700     };///END OF SECONDKEYPROXY
     717    };//END OF SECONDKEYPROXY
    701718     
    702719  private:
Note: See TracChangeset for help on using the changeset viewer.