Changeset 1333:2640cf6547ff in lemon-0.x for src/lemon/graph_reader.h

Timestamp:

04/09/05 21:35:33 (19 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

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

Message:

Functionality changed:
The first map is the id map => The map named "id" is the id map

Documentation improvments

File:

• src/lemon/graph_reader.h (modified) (21 diffs)

src/lemon/graph_reader.h

@@ -35 +35 @@
 namespace lemon {
 
+  /// \addtogroup io_group
+  /// @{
 
   /// \brief Standard ReaderTraits for the GraphReader class.
@@ -40 +42 @@
   /// Standard ReaderTraits for the GraphReader class.
   /// It defines standard reading method for all type of value. 
+  /// \author Balazs Dezso
   struct DefaultReaderTraits {
 
-   /// \brief Template class for reading an value.
+    /// \brief Template class for reading an value.
     ///
     /// Template class for reading an value.
+    /// \author Balazs Dezso
     template <typename _Value>
     struct Reader {
@@ -58 +62 @@
     };
 
+    /// \brief Returns wheter this name is an ID map name.
+    ///
+    /// Returns wheter this name is an ID map name.
+    static bool idMapName(const std::string& name) {
+      return name == "id";
+    }
+
     /// The reader class for the not needed maps.
     typedef Reader<std::string> DefaultReader;
@@ -67 +78 @@
   /// Reader class for quoted strings. It can process the escape
   /// sequences in the string.
+  /// \author Balazs Dezso
   class QuotedStringReader {
   public:
@@ -172 +184 @@
   /// \brief The graph reader class.
   ///
-  /// \ingroup io_group
-  /// The reader class for the graph input.
+  ///
+  /// The given file format may contain several maps and labeled nodes or 
+  /// edges.
+  ///
+  /// If you read a graph you need not read all the maps and items just those
+  /// that you need. The interface of the \c GraphReader is very similar to
+  /// the GraphWriter but the reading method does not depend on the order the
+  /// given commands.
+  ///
+  /// The reader object suppose that each not readed value does not contain 
+  /// whitespaces, therefore it has some extra possibilities to control how
+  /// it should skip the values when the string representation contains spaces.
+  ///
+  /// \code
+  /// GraphReader<ListGraph> reader(std::cin, graph);
+  /// \endcode
+  ///
+  /// The \c addNodeMap() function reads a map from the \c \@nodeset section.
+  /// If there is a map that you do not want to read from the file and there is
+  /// whitespace in the string represenation of the values then you should
+  /// call the \c skipNodeMap() template member function with proper 
+  /// parameters.
+  ///
+  /// \code
+  /// reader.addNodeMap("x-coord", xCoordMap);
+  /// reader.addNodeMap("y-coord", yCoordMap);
+  ///
+  /// reader.addNodeMap<QuotedStringReader>("label", labelMap);
+  /// reader.skipNodeMap<QuotedStringReader>("description");
+  ///
+  /// reader.addNodeMap("color", colorMap);
+  /// \endcode
+  ///
+  /// With the \c addEdgeMap() member function you can give an edge map
+  /// reading command similar to the NodeMaps. 
+  ///
+  /// \code
+  /// reader.addEdgeMap("weight", weightMap);
+  /// reader.addEdgeMap("label", labelMap);
+  /// \endcode
+  ///
+  /// With \c addNode() and \c addEdge() functions you can read labeled Nodes 
+  /// and Edges.
+  ///
+  /// \code
+  /// reader.addNode("source", sourceNode);
+  /// reader.addNode("target", targetNode);
+  ///
+  /// reader.addEdge("observed", edge);
+  /// \endcode
+  ///
+  /// After you give all read commands you must call the \c run() member
+  /// function, which execute all the commands.
+  ///
+  /// \code
+  /// reader.run();
+  /// \endcode
+  ///
   /// \see DefaultReaderTraits
   /// \see QuotedStringReader
   /// \see \ref GraphWriter
   /// \see \ref graph-io-page
+  /// \author Balazs Dezso
   template <typename _Graph, typename _ReaderTraits = DefaultReaderTraits> 
   class GraphReader {
@@ -201 +270 @@
     /// Destruct the graph reader.
     ~GraphReader() {
-
       for (typename NodeMapReaders::iterator it = node_map_readers.begin(); 
            it != node_map_readers.end(); ++it) {
@@ -365 +433 @@
         std::istringstream ls(line);    
         while (ls >> id) {
-          if (id[0] == '#') break;
           typename NodeMapReaders::iterator it = node_map_readers.find(id);
           if (it != node_map_readers.end()) {
@@ -373 +440 @@
             index.push_back(&nodeSkipper);
           }
-        }
-      }
-
-      if (index.size() == 0) {
-        throw DataFormatError("Cannot find node id map");
-      }
-
-      nodeInverter = 
-        std::auto_ptr<InverterBase<Node> >(index[0]->getInverter());
+          if (ReaderTraits::idMapName(id) && nodeInverter.get() == 0) {
+            nodeInverter.reset(index.back()->getInverter());
+            index.back() = nodeInverter.get();
+          }
+        }
+      }
+
+//       if (index.size() == 0) {
+//      throw DataFormatError("Cannot find node id map");
+//       }
+
+//       nodeInverter = 
+//      std::auto_ptr<InverterBase<Node> >(index[0]->getInverter());
       std::string line;
       while (line = readNotEmptyLine(is, line_num), line[0] != '@') {
         Node node = graph.addNode();
         std::istringstream ls(line);
-        nodeInverter->read(ls, node);
-        for (int i = 1; i < (int)index.size(); ++i) {
+        for (int i = 0; i < (int)index.size(); ++i) {
           index[i]->read(ls, node);
         }
@@ -403 +473 @@
         std::istringstream ls(line);    
         while (ls >> id) {
-          if (id[0] == '#') break;
           typename EdgeMapReaders::iterator it = edge_map_readers.find(id);
           if (it != edge_map_readers.end()) {
@@ -411 +480 @@
             index.push_back(&edgeSkipper);
           }
-        }
-      }
-
-      if (index.size() == 0) {
-        throw DataFormatError("Cannot find edge id map");
-      }
-
-      edgeInverter = 
-        std::auto_ptr<InverterBase<Edge> >(index[0]->getInverter());
+          if (ReaderTraits::idMapName(id) && edgeInverter.get() == 0) {
+            edgeInverter.reset(index.back()->getInverter());
+            index.back() = edgeInverter.get();
+          }
+        }
+      }
+      
+      if (nodeInverter.get() == 0) {
+        throw DataFormatError("Cannot find node id map");
+      }
+//       if (index.size() == 0) {
+//      throw DataFormatError("Cannot find edge id map");
+//       }
+
+//       edgeInverter = 
+//      std::auto_ptr<InverterBase<Edge> >(index[0]->getInverter());
       std::string line;
       while (line = readNotEmptyLine(is, line_num), line[0] != '@') {   
@@ -426 +502 @@
         Node target = nodeInverter->read(ls);
         Edge edge = graph.addEdge(source, target);
-        edgeInverter->read(ls, edge);
-        for (int i = 1; i < (int)index.size(); ++i) {
+        for (int i = 0; i < (int)index.size(); ++i) {
           index[i]->read(ls, edge);
         }
@@ -437 +512 @@
                           std::auto_ptr<InverterBase<Node> >& nodeInverter) {
       std::string line;
+      if (nodeInverter.get() == 0) {
+        throw DataFormatError("Cannot find node id map");
+      }
       while (line = readNotEmptyLine(is, line_num), line[0] != '@') {
         std::istringstream ls(line);
@@ -452 +530 @@
                           std::auto_ptr<InverterBase<Edge> >& edgeInverter) {
       std::string line;
+      if (edgeInverter.get() == 0) {
+        throw DataFormatError("Cannot find edge id map");
+      }
       while (line = readNotEmptyLine(is, line_num), line[0] != '@') {
         std::istringstream ls(line);
@@ -467 +548 @@
       std::string line;
       while (++line_num, getline(is, line)) {   
-        int vi = line.find_first_not_of(" \t");
-        if (vi != (int)std::string::npos && line[vi] != '#') {
+        int vi = line.find('#');
+        if (vi != (int)::std::string::npos) {
+          line = line.substr(0, vi);
+        }
+        vi = line.find_first_not_of(" \t");
+        if (vi != (int)std::string::npos) { 
+          std::cerr << "Line: " << line.substr(vi) << std::endl;
           return line.substr(vi);
         }
@@ -474 +560 @@
       throw DataFormatError("End of stream error");
     }
-    
-    // Inverters store and give back the Item from the id,
-    // and may put the ids into a map.
     
     template <typename _Item>
-    class InverterBase {
+    class ReaderBase;
+    
+    template <typename _Item>
+    class InverterBase : public ReaderBase<_Item> {
     public:
       typedef _Item Item;
       virtual void read(std::istream&, const Item&) = 0;
       virtual Item read(std::istream&) = 0;
+
+      virtual InverterBase<_Item>* getInverter() {
+        return this;
+      }
     };
 
@@ -652 +742 @@
   };
 
-  /// Ready to use reader function.  
+  /// \brief Read a graph from the input.
+  ///
+  /// Read a graph from the input.
+  /// \param is The input stream.
+  /// \param g The graph.
+  /// \param capacity The capacity map.
+  /// \param s The source node.
+  /// \param t The target node.
+  /// \param cost The cost map.
   template<typename Graph, typename CapacityMap, typename CostMap>
   void readGraph(std::istream& is, Graph &g, CapacityMap& capacity, 
@@ -665 +763 @@
   }
 
+  /// \brief Read a graph from the input.
+  ///
+  /// Read a graph from the input.
+  /// \param is The input stream.
+  /// \param g The graph.
+  /// \param capacity The capacity map.
+  /// \param s The source node.
+  /// \param t The target node.
   template<typename Graph, typename CapacityMap>
   void readGraph(std::istream& is, Graph &g, CapacityMap& capacity, 
@@ -675 +781 @@
   }
 
+  /// \brief Read a graph from the input.
+  ///
+  /// Read a graph from the input.
+  /// \param is The input stream.
+  /// \param g The graph.
+  /// \param capacity The capacity map.
+  /// \param s The source node.
   template<typename Graph, typename CapacityMap>
   void readGraph(std::istream& is, Graph &g, CapacityMap& capacity, 
@@ -684 +797 @@
   }
 
+  /// \brief Read a graph from the input.
+  ///
+  /// Read a graph from the input.
+  /// \param is The input stream.
+  /// \param g The graph.
+  /// \param capacity The capacity map.
   template<typename Graph, typename CapacityMap>
   void readGraph(std::istream& is, Graph &g, CapacityMap& capacity) {
@@ -691 +810 @@
   }
 
+  /// \brief Read a graph from the input.
+  ///
+  /// Read a graph from the input.
+  /// \param is The input stream.
+  /// \param g The graph.
   template<typename Graph>
   void readGraph(std::istream& is, Graph &g) {
@@ -697 +821 @@
   }
 
+  /// @}
 }