lemon/hypercube_graph.h
changeset 782 853fcddcf282
parent 664 4137ef9aacc6
child 784 9d6c3e8b2421
     1.1 --- a/lemon/hypercube_graph.h	Sun Aug 23 11:07:50 2009 +0200
     1.2 +++ b/lemon/hypercube_graph.h	Sun Aug 23 11:09:22 2009 +0200
     1.3 @@ -282,17 +282,20 @@
     1.4    ///
     1.5    /// \brief Hypercube graph class
     1.6    ///
     1.7 -  /// This class implements a special graph type. The nodes of the graph
     1.8 -  /// are indiced with integers with at most \c dim binary digits.
     1.9 +  /// HypercubeGraph implements a special graph type. The nodes of the
    1.10 +  /// graph are indexed with integers having at most \c dim binary digits.
    1.11    /// Two nodes are connected in the graph if and only if their indices
    1.12    /// differ only on one position in the binary form.
    1.13 +  /// This class is completely static and it needs constant memory space.
    1.14 +  /// Thus you can neither add nor delete nodes or edges.
    1.15 +  ///
    1.16 +  /// This type fully conforms to the \ref concepts::Graph "Graph concept".
    1.17 +  /// Most of its member functions and nested classes are documented
    1.18 +  /// only in the concept class.
    1.19    ///
    1.20    /// \note The type of the indices is chosen to \c int for efficiency
    1.21    /// reasons. Thus the maximum dimension of this implementation is 26
    1.22    /// (assuming that the size of \c int is 32 bit).
    1.23 -  ///
    1.24 -  /// This graph type fully conforms to the \ref concepts::Graph
    1.25 -  /// "Graph concept".
    1.26    class HypercubeGraph : public ExtendedHypercubeGraphBase {
    1.27      typedef ExtendedHypercubeGraphBase Parent;
    1.28  
    1.29 @@ -320,7 +323,7 @@
    1.30      /// \brief The dimension id of an edge.
    1.31      ///
    1.32      /// Gives back the dimension id of the given edge.
    1.33 -    /// It is in the [0..dim-1] range.
    1.34 +    /// It is in the range <tt>[0..dim-1]</tt>.
    1.35      int dimension(Edge edge) const {
    1.36        return Parent::dimension(edge);
    1.37      }
    1.38 @@ -328,7 +331,7 @@
    1.39      /// \brief The dimension id of an arc.
    1.40      ///
    1.41      /// Gives back the dimension id of the given arc.
    1.42 -    /// It is in the [0..dim-1] range.
    1.43 +    /// It is in the range <tt>[0..dim-1]</tt>.
    1.44      int dimension(Arc arc) const {
    1.45        return Parent::dimension(arc);
    1.46      }