Changeset 1540:7d028a73d7f2 in lemon-0.x for lemon

Ignore:
Timestamp:
07/05/05 16:36:10 (15 years ago)
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2034
Message:

Documented Balazs's stuff. Quite enough of that.

Location:
lemon
Files:
5 edited

Unmodified
Removed
• lemon/dfs.h

 r1536 ///\return The length of the %DFS s---t path if there exists one, ///0 otherwise. ///\note Apart from the return value, d.run(s) is ///\note Apart from the return value, d.run(s,t) is ///just a shortcut of the following code. ///\code

• lemon/graph_utils.h

 r1538 ///\brief Graph utilities. /// ///\todo Please ///revise the documentation. /// /// \brief Function to count the items in the graph. /// /// This function counts the items in the graph. /// This function counts the items (nodes, edges etc) in the graph. /// The complexity of the function is O(n) because /// it iterates on all of the items. /// This function counts the undirected edges in the graph. /// The complexity of the function is O(e) but for some /// graph structure it is specialized to run in O(1). /// graph structures it is specialized to run in O(1). template } /// \brief Copy the source map to the target map. /// /// Copy the \c source map to the \c target map. It uses the given iterator /// to iterate on the data structure and it use the \c ref mapping to /// convert the source's keys to the target's keys. /// \brief Copy a map. /// /// Thsi function copies the \c source map to the \c target map. It uses the /// given iterator to iterate on the data structure and it uses the \c ref /// mapping to convert the source's keys to the target's keys. template /// \brief Class to copy a graph to an other graph. /// /// Class to copy a graph to an other graph. It can be used easier /// with the \c copyGraph() function. /// \brief Class to copy a graph. /// /// Class to copy a graph to an other graph (duplicate a graph). The /// simplest way of using it is through the \c copyGraph() function. template class GraphCopy { /// After the copy the \c nr map will contain the mapping from the /// source graph's nodes to the target graph's nodes and the \c ecr will /// contain the mapping from the target graph's edge to the source's /// contain the mapping from the target graph's edges to the source's /// edges. template /// Provides an immutable and unique id for each item in the graph. /// The IdMap class provides a unique and immutable mapping for each item /// in the graph. /// The IdMap class provides a unique and immutable id for each item of the /// same type (e.g. node) in the graph. This id is
• \b unique: /// different items (nodes) get different ids
• \b immutable: the id of an /// item (node) does not change (even if you delete other nodes).
/// Through this map you get access (i.e. can read) the inner id values of /// the items stored in the graph. This map can be inverted with its member /// class \c InverseMap. /// template public: /// \brief The class represents the inverse of the map. /// /// The class represents the inverse of the map. /// \brief The class represents the inverse of its owner (IdMap). /// /// The class represents the inverse of its owner (IdMap). /// \see inverse() class InverseMap { /// \brief Gives back the inverse of the map. /// /// Gives back the inverse of the map. /// Gives back the inverse of the IdMap. InverseMap inverse() const { return InverseMap(*graph);} /// \brief General invertable graph-map type. /// This type provides simple invertable map functions. /// This type provides simple invertable graph-maps. /// The InvertableMap wraps an arbitrary ReadWriteMap /// and if a key is set to a new value then store it /// item in the graph. /// /// The DescriptorMap class provides a mutable, continuous and immutable /// mapping for each item in the graph. The value for an item may mutated /// on each operation when the an item erased or added to graph. /// The DescriptorMap class provides a unique and continuous (but mutable) /// descriptor (id) for each item of the same type (e.g. node) in the /// graph. This id is
• \b unique: different items (nodes) get /// different ids
• \b continuous: the range of the ids is the set of /// integers between 0 and \c n-1, where \c n is the number of the items of /// this type (e.g. nodes) (so the id of a node can change if you delete an /// other node, i.e. this id is mutable).
This map can be inverted /// with its member class \c InverseMap. /// /// \param _Graph The graph class the \c DescriptorMap belongs to. public: /// \brief The inverse map type. /// /// The inverse map type. /// \brief The inverse map type of DescriptorMap. /// /// The inverse map type of DescriptorMap. class InverseMap { public: /// \brief Returns a \ref TargetMap class /// /// This function just returns an \ref TargetMap class. /// This function just returns a \ref TargetMap class. /// \relates TargetMap template } /// \brief Returns the "forward" directed edge view of undirected edge. /// /// Returns the "forward" directed edge view of undirected edge. /// \brief Returns the "forward" directed edge view of an undirected edge. /// /// Returns the "forward" directed edge view of an undirected edge. /// \author Balazs Dezso template } /// \brief Returns the "backward" directed edge view of undirected edge. /// /// Returns the "backward" directed edge view of undirected edge. /// \brief Returns the "backward" directed edge view of an undirected edge. /// /// Returns the "backward" directed edge view of an undirected edge. /// \author Balazs Dezso template /// \brief Returns a \ref BackwardMap class /// This function just returns an \ref BackwardMap class. /// This function just returns a \ref BackwardMap class. /// \relates BackwardMap template /// \brief Map of the node in-degrees. /// /// This map returns the in-degree of a node. Ones it is constructed, /// This map returns the in-degree of a node. Once it is constructed, /// the degrees are stored in a standard NodeMap, so each query is done /// in constant time. On the other hand, the values updates automatically /// in constant time. On the other hand, the values are updated automatically /// whenever the graph changes. /// /// \brief Map of the node out-degrees. /// /// This map returns the out-degree of a node. One it is constructed, /// This map returns the out-degree of a node. Once it is constructed, /// the degrees are stored in a standard NodeMap, so each query is done /// in constant time. On the other hand, the values updates automatically /// in constant time. On the other hand, the values are updated automatically /// whenever the graph changes. ///
• lemon/graph_writer.h

 r1534 /// Before you read this documentation it might be useful to read the general /// description of  \ref graph-io-page "Graph Input-Output". /// /// If you don't need very sophisticated /// behaviour then you can use the versions of the public function } /// \brief Issue a new node map writing command for the writer. /// /// to access the encapsulated \e LemonWriter, this way /// you can attach to this writer new instances of /// \e LemonWriter::SectionWriter. /// \e LemonWriter::SectionWriter. For more details see /// the \ref rwbackground "Background of Reading and Writing". operator LemonWriter&() { return *writer; /// This function issues a new undirected edge map writing /// command to the writer. template template UndirGraphWriter& writeUndirEdgeMap(std::string name, const Map& map, const Writer& writer = Writer()) {
• lemon/lp_glpk.cc

 r1473 case LPX_D_UNDEF://Undefined (no solve has been run yet) return UNDEFINED; case LPX_D_NOFEAS://There is no feasible solution (primal, I guess) case LPX_D_NOFEAS://There is no dual feasible solution //    case LPX_D_INFEAS://Infeasible return INFEASIBLE;
Note: See TracChangeset for help on using the changeset viewer.