Changeset 1394:f0c48d7fa73d in lemon-0.x for src/lemon/graph_writer.h

Timestamp:

04/27/05 12:44:58 (19 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1851

Message:

Modifying the interface.
add -> read, write

File:

• src/lemon/graph_writer.h (modified) (14 diffs)

src/lemon/graph_writer.h

@@ -169 +169 @@
   /// \endcode
   ///
-  /// The \c addNodeMap() function declares a \c NodeMap writing command in the
-  /// \c GraphWriter. You should give as parameter the name of the map and the
-  /// map object. The NodeMap writing command with name "id" should write a 
-  /// unique map because it is regarded as ID map.
+  /// The \c writeNodeMap() function declares a \c NodeMap writing 
+  /// command in the \c GraphWriter. You should give as parameter 
+  /// the name of the map and the map object. The NodeMap writing 
+  /// 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.addNodeMap("x-coord", xCoordMap);
-  /// writer.addNodeMap("y-coord", yCoordMap);
-  /// writer.addNodeMap("color", colorMap);
+  /// writer.writeNodeMap("id", nodeIdMap);
+  ///
+  /// writer.writeNodeMap("x-coord", xCoordMap);
+  /// writer.writeNodeMap("y-coord", yCoordMap);
+  /// 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.
   ///
@@ -189 +190 @@
   /// DescriptorMap<ListGraph, Edge, ListGraph::EdgeMap<int> > 
   ///   edgeDescMap(graph);
-  /// writer.addEdgeMap("descriptor", edgeDescMap);
-  ///
-  /// writer.addEdgeMap("weight", weightMap);
-  /// writer.addEdgeMap("label", labelMap);
+  /// writer.writeEdgeMap("descriptor", edgeDescMap);
+  ///
+  /// writer.writeEdgeMap("weight", weightMap);
+  /// writer.writeEdgeMap("label", labelMap);
   /// \endcode
   ///
-  /// With \c addNode() and \c addEdge() functions you can point out Nodes and
-  /// Edges in the graph. By example, you can write out the source and target
-  /// of the graph.
+  /// With \c writeNode() and \c writeEdge() functions you can 
+  /// point out Nodes and Edges in the graph. By example, you can 
+  /// write out the source and target of the graph.
   ///
   /// \code
-  /// writer.addNode("source", sourceNode);
-  /// writer.addNode("target", targetNode);
-  ///
-  /// writer.addEdge("observed", edge);
+  /// writer.writeNode("source", sourceNode);
+  /// writer.writeNode("target", targetNode);
+  ///
+  /// writer.writeEdge("observed", edge);
   /// \endcode
   ///
@@ -217 +218 @@
   /// \see IdMap
   /// \see DescriptorMap
-  /// \see \ref GraphReader
+  /// \see \ref GraphWriter
   /// \see \ref graph-io-page
   /// \author Balazs Dezso
@@ -263 +264 @@
     /// Add a new node map writer command for the writer.
     template <typename Map>
-    GraphWriter& addNodeMap(std::string name, const Map& map) {
-      return addNodeMap<typename WriterTraits::template Writer<
+    GraphWriter& writeNodeMap(std::string name, const Map& map) {
+      return writeNodeMap<typename WriterTraits::template Writer<
         typename Map::Value>, Map>(name, map);
     }
@@ -272 +273 @@
     /// 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(
@@ -285 +286 @@
     /// Add a new edge map writer command for the writer.
     template <typename Map>
-    GraphWriter& addEdgeMap(std::string name, const Map& map) { 
-      return addEdgeMap<typename WriterTraits::template Writer<
+    GraphWriter& writeEdgeMap(std::string name, const Map& map) { 
+      return writeEdgeMap<typename WriterTraits::template Writer<
         typename Map::Value>, Map>(name, map);
     }
@@ -295 +296 @@
     /// 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, 
@@ -305 +306 @@
     ///
     /// 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;
@@ -313 +314 @@
     ///
     /// 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;
@@ -468 +469 @@
                   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);
-    reader.addEdgeMap("capacity", capacity);
-    reader.addEdgeMap("cost", cost);
-    reader.addNode("source", s);
-    reader.addNode("target", t);
-    reader.run();
+    writer.writeEdgeMap("id", edgeIdMap);
+    writer.writeEdgeMap("capacity", capacity);
+    writer.writeEdgeMap("cost", cost);
+    writer.writeNode("source", s);
+    writer.writeNode("target", t);
+    writer.run();
   }
 
@@ -492 +493 @@
                   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);
-    reader.addEdgeMap("capacity", capacity);
-    reader.addNode("source", s);
-    reader.addNode("target", t);
-    reader.run();
+    writer.writeEdgeMap("id", edgeIdMap);
+    writer.writeEdgeMap("capacity", capacity);
+    writer.writeNode("source", s);
+    writer.writeNode("target", t);
+    writer.run();
   }
 
@@ -513 +514 @@
   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);
-    reader.addEdgeMap("capacity", capacity);
-    reader.addNode("source", s);
-    reader.run();
+    writer.writeEdgeMap("id", edgeIdMap);
+    writer.writeEdgeMap("capacity", capacity);
+    writer.writeNode("source", s);
+    writer.run();
   }
 
@@ -532 +533 @@
   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);
-    reader.addEdgeMap("capacity", capacity);
-    reader.run();
+    writer.writeEdgeMap("id", edgeIdMap);
+    writer.writeEdgeMap("capacity", capacity);
+    writer.run();
   }
 
@@ -548 +549 @@
   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);
-    reader.run();
+    writer.writeEdgeMap("id", edgeIdMap);
+    writer.run();
   }