lemon-0.x: comparison src/lemon/graph

equal deleted inserted replaced

-:4f17c1c61444
+:06cb54690e9f
 ///
 /// \code
 /// GraphWriter<ListGraph> writer(std::cout, graph);
 /// \endcode
 ///
-/// The \c addNodeMap() function declares a \c NodeMap writing command in the
+/// The \c writeNodeMap() function declares a \c NodeMap writing
-/// \c GraphWriter. You should give as parameter the name of the map and the
+/// command in the \c GraphWriter. You should give as parameter
-/// map object. The NodeMap writing command with name "id" should write a
+/// the name of the map and the map object. The NodeMap writing
-/// unique map because it is regarded as ID map.
+/// command with name "id" should write a unique map because it
+/// is regarded as ID map.
 ///
 /// \code
 /// IdMap<ListGraph, Node> nodeIdMap;
-/// writer.addNodeMap("id", nodeIdMap);
+/// writer.writeNodeMap("id", nodeIdMap);
 ///
-/// writer.addNodeMap("x-coord", xCoordMap);
+/// writer.writeNodeMap("x-coord", xCoordMap);
-/// writer.addNodeMap("y-coord", yCoordMap);
+/// writer.writeNodeMap("y-coord", yCoordMap);
-/// writer.addNodeMap("color", colorMap);
+/// writer.writeNodeMap("color", colorMap);
 /// \endcode
 ///
-/// With the \c addEdgeMap() member function you can give an edge map
+/// With the \c writeEdgeMap() member function you can give an edge map
 /// writing command similar to the NodeMaps.
 ///
 /// \code
 /// DescriptorMap<ListGraph, Edge, ListGraph::EdgeMap<int> >
 ///   edgeDescMap(graph);
-/// writer.addEdgeMap("descriptor", edgeDescMap);
+/// writer.writeEdgeMap("descriptor", edgeDescMap);
 ///
-/// writer.addEdgeMap("weight", weightMap);
+/// writer.writeEdgeMap("weight", weightMap);
-/// writer.addEdgeMap("label", labelMap);
+/// writer.writeEdgeMap("label", labelMap);
 /// \endcode
 ///
-/// With \c addNode() and \c addEdge() functions you can point out Nodes and
+/// With \c writeNode() and \c writeEdge() functions you can
-/// Edges in the graph. By example, you can write out the source and target
+/// point out Nodes and Edges in the graph. By example, you can
-/// of the graph.
+/// write out the source and target of the graph.
 ///
 /// \code
-/// writer.addNode("source", sourceNode);
+/// writer.writeNode("source", sourceNode);
-/// writer.addNode("target", targetNode);
+/// writer.writeNode("target", targetNode);
 ///
-/// writer.addEdge("observed", edge);
+/// writer.writeEdge("observed", edge);
 /// \endcode
 ///
 /// After you give all write commands you must call the \c run() member
 /// function, which execute all the writer commands.
 ///
 ///
 /// \see DefaultWriterTraits
 /// \see QuotedStringWriter
 /// \see IdMap
 /// \see DescriptorMap
-/// \see \ref GraphReader
+/// \see \ref GraphWriter
 /// \see \ref graph-io-page
 /// \author Balazs Dezso
 template <typename _Graph, typename _WriterTraits = DefaultWriterTraits>
 class GraphWriter {
 public:
 /// \brief Add a new node map writer command for the writer.
 ///
 /// Add a new node map writer command for the writer.
 template <typename Map>
-GraphWriter& addNodeMap(std::string name, const Map& map) {
+GraphWriter& writeNodeMap(std::string name, const Map& map) {
-return addNodeMap<typename WriterTraits::template Writer<
+return writeNodeMap<typename WriterTraits::template Writer<
 	typename Map::Value>, Map>(name, map);
 }
 /// \brief Add a new node map writer command for the writer.
 ///
 /// Add a new node map writer command for the writer.
 template <typename Writer, typename Map>
-GraphWriter& addNodeMap(std::string name, const Map& map,
+GraphWriter& writeNodeMap(std::string name, const Map& map,
 			      const Writer& writer = Writer()) {
 node_map_writers.push_back(
 make_pair(name, new MapWriter<Node, Map, Writer>(map, writer)));
 return *this;
 }
 /// \brief Add a new edge map writer command for the writer.
 ///
 /// Add a new edge map writer command for the writer.
 template <typename Map>
-GraphWriter& addEdgeMap(std::string name, const Map& map) {
+GraphWriter& writeEdgeMap(std::string name, const Map& map) {
-return addEdgeMap<typename WriterTraits::template Writer<
+return writeEdgeMap<typename WriterTraits::template Writer<
 typename Map::Value>, Map>(name, map);
 }
 /// \brief Add a new edge map writer command for the writer.
 ///
 /// Add a new edge map writer command for the writer.
 template <typename Writer, typename Map>
-GraphWriter& addEdgeMap(std::string name,
+GraphWriter& writeEdgeMap(std::string name,
 			    const Map& map, const Writer& writer = Writer()) {
 edge_map_writers.push_back(make_pair(name,
 	new MapWriter<Edge, Map, Writer>(map, writer)));
 return *this;
 }
 /// \brief Add a new labeled node writer for the writer.
 ///
 /// Add a new labeled node writer for the writer.
-GraphWriter& addNode(std::string name, const Node& node) {
+GraphWriter& writeNode(std::string name, const Node& node) {
 node_writers.push_back(make_pair(name, node));
 return *this;
 }
 /// \brief Add a new labeled edge writer for the writer.
 ///
 /// Add a new labeled edge writer for the writer.
-GraphWriter& addEdge(std::string name, const Edge& edge) {
+GraphWriter& writeEdge(std::string name, const Edge& edge) {
 edge_writers.push_back(make_pair(name, edge));
 return *this;
 }
 /// \brief Executes the writer commands.
 /// \param cost The cost map.
 template<typename Graph, typename CapacityMap, typename CostMap>
 void writeGraph(std::ostream& os, const Graph &g,
 		  const CapacityMap& capacity, const typename Graph::Node &s,
 		  const typename Graph::Node &t, const CostMap& cost) {
-GraphWriter<Graph> reader(os, g);
+GraphWriter<Graph> writer(os, g);
 IdMap<Graph, typename Graph::Node> nodeIdMap(g);
-reader.addNodeMap("id", nodeIdMap);
+writer.writeNodeMap("id", nodeIdMap);
 IdMap<Graph, typename Graph::Edge> edgeIdMap(g);
-reader.addEdgeMap("id", edgeIdMap);
+writer.writeEdgeMap("id", edgeIdMap);
-reader.addEdgeMap("capacity", capacity);
+writer.writeEdgeMap("capacity", capacity);
-reader.addEdgeMap("cost", cost);
+writer.writeEdgeMap("cost", cost);
-reader.addNode("source", s);
+writer.writeNode("source", s);
-reader.addNode("target", t);
+writer.writeNode("target", t);
-reader.run();
+writer.run();
 }
 /// \brief Write a graph to the output.
 ///
 /// Write a graph to the output.
 /// \param t The target node.
 template<typename Graph, typename CapacityMap>
 void writeGraph(std::ostream& os, const Graph &g,
 		  const CapacityMap& capacity, const typename Graph::Node &s,
 		  const typename Graph::Node &t) {
-GraphWriter<Graph> reader(os, g);
+GraphWriter<Graph> writer(os, g);
 IdMap<Graph, typename Graph::Node> nodeIdMap(g);
-reader.addNodeMap("id", nodeIdMap);
+writer.writeNodeMap("id", nodeIdMap);
 IdMap<Graph, typename Graph::Edge> edgeIdMap(g);
-reader.addEdgeMap("id", edgeIdMap);
+writer.writeEdgeMap("id", edgeIdMap);
-reader.addEdgeMap("capacity", capacity);
+writer.writeEdgeMap("capacity", capacity);
-reader.addNode("source", s);
+writer.writeNode("source", s);
-reader.addNode("target", t);
+writer.writeNode("target", t);
-reader.run();
+writer.run();
 }
 /// \brief Write a graph to the output.
 ///
 /// Write a graph to the output.
 /// \param capacity The capacity map.
 /// \param s The source node.
 template<typename Graph, typename CapacityMap>
 void writeGraph(std::ostream& os, const Graph &g,
 		  const CapacityMap& capacity, const typename Graph::Node &s) {
-GraphWriter<Graph> reader(os, g);
+GraphWriter<Graph> writer(os, g);
 IdMap<Graph, typename Graph::Node> nodeIdMap(g);
-reader.addNodeMap("id", nodeIdMap);
+writer.writeNodeMap("id", nodeIdMap);
 IdMap<Graph, typename Graph::Edge> edgeIdMap(g);
-reader.addEdgeMap("id", edgeIdMap);
+writer.writeEdgeMap("id", edgeIdMap);
-reader.addEdgeMap("capacity", capacity);
+writer.writeEdgeMap("capacity", capacity);
-reader.addNode("source", s);
+writer.writeNode("source", s);
-reader.run();
+writer.run();
 }
 /// \brief Write a graph to the output.
 ///
 /// Write a graph to the output.
 /// \param g The graph.
 /// \param capacity The capacity map.
 template<typename Graph, typename CapacityMap>
 void writeGraph(std::ostream& os, const Graph &g,
 		  const CapacityMap& capacity) {
-GraphWriter<Graph> reader(os, g);
+GraphWriter<Graph> writer(os, g);
 IdMap<Graph, typename Graph::Node> nodeIdMap(g);
-reader.addNodeMap("id", nodeIdMap);
+writer.writeNodeMap("id", nodeIdMap);
 IdMap<Graph, typename Graph::Edge> edgeIdMap(g);
-reader.addEdgeMap("id", edgeIdMap);
+writer.writeEdgeMap("id", edgeIdMap);
-reader.addEdgeMap("capacity", capacity);
+writer.writeEdgeMap("capacity", capacity);
-reader.run();
+writer.run();
 }
 /// \brief Write a graph to the output.
 ///
 /// Write a graph to the output.
 /// \param os The output stream.
 /// \param g The graph.
 template<typename Graph>
 void writeGraph(std::ostream& os, const Graph &g) {
-GraphWriter<Graph> reader(os, g);
+GraphWriter<Graph> writer(os, g);
 IdMap<Graph, typename Graph::Node> nodeIdMap(g);
-reader.addNodeMap("id", nodeIdMap);
+writer.writeNodeMap("id", nodeIdMap);
 IdMap<Graph, typename Graph::Edge> edgeIdMap(g);
-reader.addEdgeMap("id", edgeIdMap);
+writer.writeEdgeMap("id", edgeIdMap);
-reader.run();
+writer.run();
 }
 /// @}
 }

changeset 1394	f0c48d7fa73d
parent 1359	1581f961cfaa
child 1396	56f9a4ba9149