[Lemon-commits] kpeter: r3314 - in lemon/trunk/lemon: . concepts
Lemon SVN
svn at lemon.cs.elte.hu
Thu Sep 20 01:35:29 CEST 2007
Author: kpeter
Date: Thu Sep 20 01:35:27 2007
New Revision: 3314
Modified:
lemon/trunk/lemon/concepts/bpugraph.h
lemon/trunk/lemon/concepts/graph.h
lemon/trunk/lemon/concepts/graph_components.h
lemon/trunk/lemon/concepts/ugraph.h
lemon/trunk/lemon/graph_utils.h
lemon/trunk/lemon/min_cost_flow.h
Log:
Small bug fixes and changes in the documentation.
Modified: lemon/trunk/lemon/concepts/bpugraph.h
==============================================================================
--- lemon/trunk/lemon/concepts/bpugraph.h (original)
+++ lemon/trunk/lemon/concepts/bpugraph.h Thu Sep 20 01:35:27 2007
@@ -18,8 +18,7 @@
/// \ingroup graph_concepts
/// \file
-/// \brief Undirected bipartite graphs and components of.
-
+/// \brief The concept of Bipartite Undirected Graphs.
#ifndef LEMON_CONCEPT_BPUGRAPH_H
#define LEMON_CONCEPT_BPUGRAPH_H
@@ -36,8 +35,7 @@
/// \addtogroup graph_concepts
/// @{
-
-
+ ///
/// \brief Class describing the concept of Bipartite Undirected Graphs.
///
/// This class describes the common interface of all
Modified: lemon/trunk/lemon/concepts/graph.h
==============================================================================
--- lemon/trunk/lemon/concepts/graph.h (original)
+++ lemon/trunk/lemon/concepts/graph.h Thu Sep 20 01:35:27 2007
@@ -21,7 +21,7 @@
///\ingroup graph_concepts
///\file
-///\brief Declaration of Graph.
+///\brief The concept of Directed Graphs.
#include <lemon/bits/invalid.h>
#include <lemon/bits/utility.h>
@@ -34,9 +34,9 @@
/// \addtogroup graph_concepts
/// @{
-
- /// The directed graph concept
-
+ ///
+ /// \brief Class describing the concept of Directed Graphs.
+ ///
/// This class describes the \ref concept "concept" of the
/// immutable directed graphs.
///
Modified: lemon/trunk/lemon/concepts/graph_components.h
==============================================================================
--- lemon/trunk/lemon/concepts/graph_components.h (original)
+++ lemon/trunk/lemon/concepts/graph_components.h Thu Sep 20 01:35:27 2007
@@ -18,7 +18,7 @@
///\ingroup graph_concepts
///\file
-///\brief The concept of the graph components.
+///\brief The concept of graph components.
#ifndef LEMON_CONCEPT_GRAPH_COMPONENTS_H
Modified: lemon/trunk/lemon/concepts/ugraph.h
==============================================================================
--- lemon/trunk/lemon/concepts/ugraph.h (original)
+++ lemon/trunk/lemon/concepts/ugraph.h Thu Sep 20 01:35:27 2007
@@ -18,8 +18,7 @@
///\ingroup graph_concepts
///\file
-///\brief The concept of the undirected graphs.
-
+///\brief The concept of Undirected Graphs.
#ifndef LEMON_CONCEPT_UGRAPH_H
#define LEMON_CONCEPT_UGRAPH_H
@@ -33,8 +32,7 @@
/// \addtogroup graph_concepts
/// @{
-
-
+ ///
/// \brief Class describing the concept of Undirected Graphs.
///
/// This class describes the common interface of all Undirected
Modified: lemon/trunk/lemon/graph_utils.h
==============================================================================
--- lemon/trunk/lemon/graph_utils.h (original)
+++ lemon/trunk/lemon/graph_utils.h Thu Sep 20 01:35:27 2007
@@ -36,9 +36,6 @@
///\ingroup gutils
///\file
///\brief Graph utilities.
-///
-///
-
namespace lemon {
@@ -149,7 +146,7 @@
/// The complexity of the function is O(n) but for some
/// graph structures it is specialized to run in O(1).
///
- /// \todo refer how to specialize it
+ /// \todo Refer how to specialize it.
template <typename Graph>
inline int countNodes(const Graph& g) {
@@ -182,7 +179,7 @@
/// The complexity of the function is O(an) but for some
/// graph structures it is specialized to run in O(1).
///
- /// \todo refer how to specialize it
+ /// \todo Refer how to specialize it.
template <typename Graph>
inline int countANodes(const Graph& g) {
@@ -215,7 +212,7 @@
/// The complexity of the function is O(bn) but for some
/// graph structures it is specialized to run in O(1).
///
- /// \todo refer how to specialize it
+ /// \todo Refer how to specialize it.
template <typename Graph>
inline int countBNodes(const Graph& g) {
@@ -375,7 +372,7 @@
///\endcode
///
///\sa EdgeLookUp
- ///\se AllEdgeLookup
+ ///\se AllEdgeLookUp
///\sa ConEdgeIt
template <typename Graph>
inline typename Graph::Edge
@@ -397,7 +394,7 @@
///
///\sa findEdge()
///\sa EdgeLookUp
- ///\sa AllEdgeLookup
+ ///\sa AllEdgeLookUp
///
/// \author Balazs Dezso
template <typename _Graph>
@@ -2041,6 +2038,7 @@
/// \brief Returns the source of the given edge.
///
/// The SourceMap gives back the source Node of the given edge.
+ /// \see TargetMap
/// \author Balazs Dezso
template <typename Graph>
class SourceMap {
@@ -2068,7 +2066,7 @@
const Graph& graph;
};
- /// \brief Returns a \ref SourceMap class
+ /// \brief Returns a \ref SourceMap class.
///
/// This function just returns an \ref SourceMap class.
/// \relates SourceMap
@@ -2080,6 +2078,7 @@
/// \brief Returns the target of the given edge.
///
/// The TargetMap gives back the target Node of the given edge.
+ /// \see SourceMap
/// \author Balazs Dezso
template <typename Graph>
class TargetMap {
@@ -2107,7 +2106,7 @@
const Graph& graph;
};
- /// \brief Returns a \ref TargetMap class
+ /// \brief Returns a \ref TargetMap class.
///
/// This function just returns a \ref TargetMap class.
/// \relates TargetMap
@@ -2119,6 +2118,7 @@
/// \brief Returns the "forward" directed edge view of an undirected edge.
///
/// Returns the "forward" directed edge view of an undirected edge.
+ /// \see BackwardMap
/// \author Balazs Dezso
template <typename Graph>
class ForwardMap {
@@ -2146,7 +2146,7 @@
const Graph& graph;
};
- /// \brief Returns a \ref ForwardMap class
+ /// \brief Returns a \ref ForwardMap class.
///
/// This function just returns an \ref ForwardMap class.
/// \relates ForwardMap
@@ -2158,6 +2158,7 @@
/// \brief Returns the "backward" directed edge view of an undirected edge.
///
/// Returns the "backward" directed edge view of an undirected edge.
+ /// \see ForwardMap
/// \author Balazs Dezso
template <typename Graph>
class BackwardMap {
@@ -2224,9 +2225,9 @@
const NodeMap& potential;
};
- /// \brief Just returns a PotentialDifferenceMap
+ /// \brief Returns a PotentialDifferenceMap.
///
- /// Just returns a PotentialDifferenceMap
+ /// This function just returns a PotentialDifferenceMap.
/// \relates PotentialDifferenceMap
template <typename Graph, typename NodeMap>
PotentialDifferenceMap<Graph, NodeMap>
Modified: lemon/trunk/lemon/min_cost_flow.h
==============================================================================
--- lemon/trunk/lemon/min_cost_flow.h (original)
+++ lemon/trunk/lemon/min_cost_flow.h Thu Sep 20 01:35:27 2007
@@ -39,7 +39,7 @@
/// \note \ref lemon::MinCostFlow "MinCostFlow" is just an alias for
/// \ref lemon::NetworkSimplex "NetworkSimplex", wich is the most
/// efficient implementation for the minimum cost flow problem in the
- /// Lemon library according to our benchmark tests.
+ /// LEMON library according to our benchmark tests.
///
/// \note There are three implementations for the minimum cost flow
/// problem, that can be used in the same way.
More information about the Lemon-commits
mailing list