[1137] | 1 | /* -*- C++ -*- |
---|
| 2 | * |
---|
[1956] | 3 | * This file is a part of LEMON, a generic C++ optimization library |
---|
| 4 | * |
---|
[2391] | 5 | * Copyright (C) 2003-2007 |
---|
[1956] | 6 | * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport |
---|
[1359] | 7 | * (Egervary Research Group on Combinatorial Optimization, EGRES). |
---|
[1137] | 8 | * |
---|
| 9 | * Permission to use, modify and distribute this software is granted |
---|
| 10 | * provided that this copyright notice appears in all copies. For |
---|
| 11 | * precise terms see the accompanying LICENSE file. |
---|
| 12 | * |
---|
| 13 | * This software is provided "AS IS" with no warranty of any kind, |
---|
| 14 | * express or implied, and with no claim as to its suitability for any |
---|
| 15 | * purpose. |
---|
| 16 | * |
---|
| 17 | */ |
---|
| 18 | |
---|
[2083] | 19 | ///\ingroup lemon_io |
---|
[1137] | 20 | ///\file |
---|
[1287] | 21 | ///\brief Lemon Graph Format writer. |
---|
[1534] | 22 | /// |
---|
[1137] | 23 | |
---|
[1214] | 24 | #ifndef LEMON_GRAPH_WRITER_H |
---|
| 25 | #define LEMON_GRAPH_WRITER_H |
---|
[1137] | 26 | |
---|
| 27 | #include <iostream> |
---|
| 28 | |
---|
| 29 | #include <lemon/error.h> |
---|
[1409] | 30 | #include <lemon/lemon_writer.h> |
---|
[1137] | 31 | |
---|
| 32 | namespace lemon { |
---|
| 33 | |
---|
[2083] | 34 | /// \addtogroup lemon_io |
---|
[1333] | 35 | /// @{ |
---|
| 36 | |
---|
[1137] | 37 | /// \brief The graph writer class. |
---|
| 38 | /// |
---|
[2200] | 39 | /// The \c GraphWriter class provides the graph output. Before you |
---|
| 40 | /// read this documentation it might be useful to read the general |
---|
| 41 | /// description of \ref graph-io-page "Graph Input-Output". |
---|
[1540] | 42 | /// |
---|
[2200] | 43 | /// To write a graph you should first give writing commands to the |
---|
| 44 | /// writer. You can declare write commands as \c NodeMap or \c |
---|
| 45 | /// EdgeMap writing and labeled Node and Edge writing. |
---|
[1333] | 46 | /// |
---|
[1946] | 47 | ///\code |
---|
[1333] | 48 | /// GraphWriter<ListGraph> writer(std::cout, graph); |
---|
[1946] | 49 | ///\endcode |
---|
[1333] | 50 | /// |
---|
[2200] | 51 | /// The \c writeNodeMap() function declares a \c NodeMap writing |
---|
| 52 | /// command in the \c GraphWriter. You should give as parameter the |
---|
| 53 | /// name of the map and the map object. The NodeMap writing command |
---|
| 54 | /// with name "label" should write a unique map because it is |
---|
| 55 | /// regarded as label map (such a map is essential if the graph has |
---|
| 56 | /// edges). |
---|
[1333] | 57 | /// |
---|
[1946] | 58 | ///\code |
---|
[1901] | 59 | /// IdMap<ListGraph, Node> nodeLabelMap; |
---|
| 60 | /// writer.writeNodeMap("label", nodeLabelMap); |
---|
[1333] | 61 | /// |
---|
[1421] | 62 | /// writer.writeNodeMap("coords", coords); |
---|
[1394] | 63 | /// writer.writeNodeMap("color", colorMap); |
---|
[1946] | 64 | ///\endcode |
---|
[1333] | 65 | /// |
---|
[1394] | 66 | /// With the \c writeEdgeMap() member function you can give an edge map |
---|
[1333] | 67 | /// writing command similar to the NodeMaps. |
---|
| 68 | /// |
---|
[1946] | 69 | ///\code |
---|
[1333] | 70 | /// DescriptorMap<ListGraph, Edge, ListGraph::EdgeMap<int> > |
---|
| 71 | /// edgeDescMap(graph); |
---|
[1394] | 72 | /// writer.writeEdgeMap("descriptor", edgeDescMap); |
---|
[1333] | 73 | /// |
---|
[1394] | 74 | /// writer.writeEdgeMap("weight", weightMap); |
---|
| 75 | /// writer.writeEdgeMap("label", labelMap); |
---|
[1946] | 76 | ///\endcode |
---|
[1333] | 77 | /// |
---|
[1394] | 78 | /// With \c writeNode() and \c writeEdge() functions you can |
---|
[1526] | 79 | /// point out Nodes and Edges in the graph. For example, you can |
---|
| 80 | /// write out the source and target of a maximum flow instance. |
---|
[1333] | 81 | /// |
---|
[1946] | 82 | ///\code |
---|
[1394] | 83 | /// writer.writeNode("source", sourceNode); |
---|
| 84 | /// writer.writeNode("target", targetNode); |
---|
[1333] | 85 | /// |
---|
[1394] | 86 | /// writer.writeEdge("observed", edge); |
---|
[1946] | 87 | ///\endcode |
---|
[1333] | 88 | /// |
---|
| 89 | /// After you give all write commands you must call the \c run() member |
---|
[1526] | 90 | /// function, which executes all the writing commands. |
---|
[1333] | 91 | /// |
---|
[1946] | 92 | ///\code |
---|
[1333] | 93 | /// writer.run(); |
---|
[1946] | 94 | ///\endcode |
---|
[1333] | 95 | /// |
---|
[1287] | 96 | /// \see DefaultWriterTraits |
---|
| 97 | /// \see QuotedStringWriter |
---|
[1333] | 98 | /// \see IdMap |
---|
| 99 | /// \see DescriptorMap |
---|
[1421] | 100 | /// \see \ref GraphReader |
---|
[1138] | 101 | /// \see \ref graph-io-page |
---|
[1333] | 102 | /// \author Balazs Dezso |
---|
[1137] | 103 | template <typename _Graph, typename _WriterTraits = DefaultWriterTraits> |
---|
| 104 | class GraphWriter { |
---|
| 105 | public: |
---|
| 106 | |
---|
| 107 | typedef _Graph Graph; |
---|
| 108 | typedef typename Graph::Node Node; |
---|
| 109 | typedef typename Graph::Edge Edge; |
---|
| 110 | |
---|
| 111 | typedef _WriterTraits WriterTraits; |
---|
[1409] | 112 | |
---|
[1137] | 113 | /// \brief Construct a new GraphWriter. |
---|
| 114 | /// |
---|
[1526] | 115 | /// This function constructs a new GraphWriter to write the given graph |
---|
[1409] | 116 | /// to the given stream. |
---|
[1208] | 117 | GraphWriter(std::ostream& _os, const Graph& _graph) |
---|
[1409] | 118 | : writer(new LemonWriter(_os)), own_writer(true), |
---|
[1421] | 119 | nodeset_writer(*writer, _graph, std::string()), |
---|
| 120 | edgeset_writer(*writer, _graph, nodeset_writer, std::string()), |
---|
[1409] | 121 | node_writer(*writer, nodeset_writer, std::string()), |
---|
| 122 | edge_writer(*writer, edgeset_writer, std::string()), |
---|
| 123 | attribute_writer(*writer, std::string()) {} |
---|
[1137] | 124 | |
---|
[1409] | 125 | /// \brief Construct a new GraphWriter. |
---|
| 126 | /// |
---|
[1526] | 127 | /// This function constructs a new GraphWriter to write the given graph |
---|
[1409] | 128 | /// to the given file. |
---|
| 129 | GraphWriter(const std::string& _filename, const Graph& _graph) |
---|
| 130 | : writer(new LemonWriter(_filename)), own_writer(true), |
---|
[1421] | 131 | nodeset_writer(*writer, _graph, std::string()), |
---|
| 132 | edgeset_writer(*writer, _graph, nodeset_writer, std::string()), |
---|
[1409] | 133 | node_writer(*writer, nodeset_writer, std::string()), |
---|
| 134 | edge_writer(*writer, edgeset_writer, std::string()), |
---|
| 135 | attribute_writer(*writer, std::string()) {} |
---|
| 136 | |
---|
| 137 | /// \brief Construct a new GraphWriter. |
---|
| 138 | /// |
---|
[1526] | 139 | /// This function constructs a new GraphWriter to write the given graph |
---|
| 140 | /// to the given LemonReader. |
---|
[1409] | 141 | GraphWriter(LemonWriter& _writer, const Graph& _graph) |
---|
| 142 | : writer(_writer), own_writer(false), |
---|
[1421] | 143 | nodeset_writer(*writer, _graph, std::string()), |
---|
| 144 | edgeset_writer(*writer, _graph, nodeset_writer, std::string()), |
---|
[1409] | 145 | node_writer(*writer, nodeset_writer, std::string()), |
---|
| 146 | edge_writer(*writer, edgeset_writer, std::string()), |
---|
| 147 | attribute_writer(*writer, std::string()) {} |
---|
[1137] | 148 | |
---|
| 149 | /// \brief Destruct the graph writer. |
---|
| 150 | /// |
---|
[1526] | 151 | /// This function destructs the graph writer. |
---|
[1137] | 152 | ~GraphWriter() { |
---|
[1409] | 153 | if (own_writer) |
---|
| 154 | delete writer; |
---|
[1137] | 155 | } |
---|
| 156 | |
---|
[1526] | 157 | /// \brief Issue a new node map writing command for the writer. |
---|
[1137] | 158 | /// |
---|
[1526] | 159 | /// This function issues a new <i> node map writing command</i> to the writer. |
---|
[1137] | 160 | template <typename Map> |
---|
[2386] | 161 | GraphWriter& writeNodeMap(std::string label, const Map& map) { |
---|
| 162 | nodeset_writer.writeNodeMap(label, map); |
---|
[1409] | 163 | return *this; |
---|
[1137] | 164 | } |
---|
| 165 | |
---|
[1540] | 166 | |
---|
[1526] | 167 | /// \brief Issue a new node map writing command for the writer. |
---|
[1137] | 168 | /// |
---|
[1526] | 169 | /// This function issues a new <i> node map writing command</i> to the writer. |
---|
[2386] | 170 | template <typename ItemWriter, typename Map> |
---|
| 171 | GraphWriter& writeNodeMap(std::string label, const Map& map, |
---|
| 172 | const ItemWriter& iw = ItemWriter()) { |
---|
| 173 | nodeset_writer.writeNodeMap(label, map, iw); |
---|
[1137] | 174 | return *this; |
---|
| 175 | } |
---|
| 176 | |
---|
| 177 | |
---|
[1526] | 178 | /// \brief Issue a new edge map writing command for the writer. |
---|
[1137] | 179 | /// |
---|
[1526] | 180 | /// This function issues a new <i> edge map writing command</i> to the writer. |
---|
[1137] | 181 | template <typename Map> |
---|
[2386] | 182 | GraphWriter& writeEdgeMap(std::string label, const Map& map) { |
---|
| 183 | edgeset_writer.writeEdgeMap(label, map); |
---|
[1409] | 184 | return *this; |
---|
[1137] | 185 | } |
---|
| 186 | |
---|
| 187 | |
---|
[1526] | 188 | /// \brief Issue a new edge map writing command for the writer. |
---|
[1137] | 189 | /// |
---|
[1526] | 190 | /// This function issues a new <i> edge map writing command</i> to the writer. |
---|
[2386] | 191 | template <typename ItemWriter, typename Map> |
---|
| 192 | GraphWriter& writeEdgeMap(std::string label, const Map& map, |
---|
| 193 | const ItemWriter& iw = ItemWriter()) { |
---|
| 194 | edgeset_writer.writeEdgeMap(label, map, iw); |
---|
[1137] | 195 | return *this; |
---|
| 196 | } |
---|
| 197 | |
---|
[1526] | 198 | /// \brief Issue a new labeled node writing command to the writer. |
---|
[1137] | 199 | /// |
---|
[1526] | 200 | /// This function issues a new <i> labeled node writing command</i> |
---|
| 201 | /// to the writer. |
---|
[2386] | 202 | GraphWriter& writeNode(std::string label, const Node& node) { |
---|
| 203 | node_writer.writeNode(label, node); |
---|
[1137] | 204 | return *this; |
---|
| 205 | } |
---|
| 206 | |
---|
[1526] | 207 | /// \brief Issue a new labeled edge writing command to the writer. |
---|
[1137] | 208 | /// |
---|
[1526] | 209 | /// This function issues a new <i> labeled edge writing command</i> |
---|
| 210 | /// to the writer. |
---|
[2386] | 211 | GraphWriter& writeEdge(std::string label, const Edge& edge) { |
---|
| 212 | edge_writer.writeEdge(label, edge); |
---|
[1409] | 213 | } |
---|
| 214 | |
---|
[1526] | 215 | /// \brief Issue a new attribute writing command. |
---|
[1409] | 216 | /// |
---|
[1526] | 217 | /// This function issues a new <i> attribute writing command</i> |
---|
| 218 | /// to the writer. |
---|
[1409] | 219 | template <typename Value> |
---|
[2386] | 220 | GraphWriter& writeAttribute(std::string label, const Value& value) { |
---|
| 221 | attribute_writer.writeAttribute(label, value); |
---|
[1409] | 222 | return *this; |
---|
| 223 | } |
---|
| 224 | |
---|
[1526] | 225 | /// \brief Issue a new attribute writing command. |
---|
[1409] | 226 | /// |
---|
[1526] | 227 | /// This function issues a new <i> attribute writing command</i> |
---|
| 228 | /// to the writer. |
---|
[2386] | 229 | template <typename ItemWriter, typename Value> |
---|
| 230 | GraphWriter& writeAttribute(std::string label, const Value& value, |
---|
| 231 | const ItemWriter& iw = ItemWriter()) { |
---|
| 232 | attribute_writer.writeAttribute(label, value, iw); |
---|
[1137] | 233 | return *this; |
---|
| 234 | } |
---|
| 235 | |
---|
[1409] | 236 | /// \brief Conversion operator to LemonWriter. |
---|
| 237 | /// |
---|
[1526] | 238 | /// Conversion operator to LemonWriter. It makes possible |
---|
[1409] | 239 | /// to access the encapsulated \e LemonWriter, this way |
---|
| 240 | /// you can attach to this writer new instances of |
---|
[1540] | 241 | /// \e LemonWriter::SectionWriter. For more details see |
---|
| 242 | /// the \ref rwbackground "Background of Reading and Writing". |
---|
[1409] | 243 | operator LemonWriter&() { |
---|
| 244 | return *writer; |
---|
[1396] | 245 | } |
---|
| 246 | |
---|
[1526] | 247 | /// \brief Executes the writing commands. |
---|
[1137] | 248 | /// |
---|
[1526] | 249 | /// Executes the writing commands. |
---|
[1409] | 250 | void run() { |
---|
| 251 | writer->run(); |
---|
[1137] | 252 | } |
---|
| 253 | |
---|
[2467] | 254 | /// \brief Returns true if the writer can give back the labels by the items. |
---|
| 255 | /// |
---|
| 256 | /// Returns true if the writer can give back the the labels by the items. |
---|
| 257 | bool isLabelWriter() const { |
---|
| 258 | return nodeset_writer.isLabelWriter() && |
---|
| 259 | edgeset_writer.isLabelWriter(); |
---|
| 260 | } |
---|
| 261 | |
---|
[1901] | 262 | /// \brief Write the label of the given node. |
---|
[1429] | 263 | /// |
---|
[2467] | 264 | /// It writes the label of the given node. If there was written a "label" |
---|
[1526] | 265 | /// named node map then it will write the map value belonging to the node. |
---|
[1901] | 266 | void writeLabel(std::ostream& os, const Node& item) const { |
---|
| 267 | nodeset_writer.writeLabel(os, item); |
---|
[1429] | 268 | } |
---|
| 269 | |
---|
[1901] | 270 | /// \brief Write the label of the given edge. |
---|
[1429] | 271 | /// |
---|
[2467] | 272 | /// It writes the label of the given edge. If there was written a "label" |
---|
[1526] | 273 | /// named edge map then it will write the map value belonging to the edge. |
---|
[1901] | 274 | void writeLabel(std::ostream& os, const Edge& item) const { |
---|
| 275 | edgeset_writer.writeLabel(os, item); |
---|
[1429] | 276 | } |
---|
| 277 | |
---|
[2467] | 278 | /// \brief Sorts the given node vector by label. |
---|
| 279 | /// |
---|
| 280 | /// Sorts the given node vector by label. If there was written an |
---|
| 281 | /// "label" named map then the vector will be sorted by the values |
---|
| 282 | /// of this map. Otherwise if the \c forceLabel parameter was true |
---|
| 283 | /// it will be sorted by its id in the graph. |
---|
| 284 | void sortByLabel(std::vector<Node>& nodes) const { |
---|
| 285 | nodeset_writer.sortByLabel(nodes); |
---|
| 286 | } |
---|
| 287 | |
---|
| 288 | /// \brief Sorts the given edge vector by label. |
---|
| 289 | /// |
---|
| 290 | /// Sorts the given edge vector by label. If there was written an |
---|
| 291 | /// "label" named map then the vector will be sorted by the values |
---|
| 292 | /// of this map. Otherwise if the \c forceLabel parameter was true |
---|
| 293 | /// it will be sorted by its id in the graph. |
---|
| 294 | void sortByLabel(std::vector<Edge>& edges) const { |
---|
| 295 | edgeset_writer.sortByLabel(edges); |
---|
| 296 | } |
---|
| 297 | |
---|
[1137] | 298 | private: |
---|
| 299 | |
---|
[1409] | 300 | LemonWriter* writer; |
---|
| 301 | bool own_writer; |
---|
[1137] | 302 | |
---|
[1409] | 303 | NodeSetWriter<Graph, WriterTraits> nodeset_writer; |
---|
| 304 | EdgeSetWriter<Graph, WriterTraits> edgeset_writer; |
---|
| 305 | |
---|
| 306 | NodeWriter<Graph> node_writer; |
---|
| 307 | EdgeWriter<Graph> edge_writer; |
---|
| 308 | |
---|
| 309 | AttributeWriter<WriterTraits> attribute_writer; |
---|
[1137] | 310 | }; |
---|
| 311 | |
---|
[1409] | 312 | |
---|
[1421] | 313 | /// \brief The undirected graph writer class. |
---|
| 314 | /// |
---|
[1909] | 315 | /// The \c UGraphWriter class provides the ugraph output. To write |
---|
[1526] | 316 | /// a graph you should first give writing commands to the writer. You can |
---|
[1909] | 317 | /// declare write command as \c NodeMap, \c EdgeMap or \c UEdgeMap |
---|
| 318 | /// writing and labeled Node, Edge or UEdge writing. |
---|
[1421] | 319 | /// |
---|
[1946] | 320 | ///\code |
---|
[1909] | 321 | /// UGraphWriter<ListUGraph> writer(std::cout, graph); |
---|
[1946] | 322 | ///\endcode |
---|
[1421] | 323 | /// |
---|
| 324 | /// The \c writeNodeMap() function declares a \c NodeMap writing |
---|
[1909] | 325 | /// command in the \c UGraphWriter. You should give as parameter |
---|
[1421] | 326 | /// the name of the map and the map object. The NodeMap writing |
---|
[1901] | 327 | /// command with name "label" should write a unique map because it |
---|
| 328 | /// is regarded as label map. |
---|
[1421] | 329 | /// |
---|
[1946] | 330 | ///\code |
---|
[1909] | 331 | /// IdMap<ListUGraph, Node> nodeLabelMap; |
---|
[1901] | 332 | /// writer.writeNodeMap("label", nodeLabelMap); |
---|
[1421] | 333 | /// |
---|
| 334 | /// writer.writeNodeMap("coords", coords); |
---|
| 335 | /// writer.writeNodeMap("color", colorMap); |
---|
[1946] | 336 | ///\endcode |
---|
[1421] | 337 | /// |
---|
[1909] | 338 | /// With the \c writeUEdgeMap() member function you can give an |
---|
[1421] | 339 | /// undirected edge map writing command similar to the NodeMaps. |
---|
| 340 | /// |
---|
[1946] | 341 | ///\code |
---|
[1421] | 342 | /// DescriptorMap<ListGraph, Edge, ListGraph::EdgeMap<int> > |
---|
| 343 | /// edgeDescMap(graph); |
---|
[1909] | 344 | /// writer.writeUEdgeMap("descriptor", edgeDescMap); |
---|
[1421] | 345 | /// |
---|
[1909] | 346 | /// writer.writeUEdgeMap("weight", weightMap); |
---|
| 347 | /// writer.writeUEdgeMap("label", labelMap); |
---|
[1946] | 348 | ///\endcode |
---|
[1421] | 349 | /// |
---|
| 350 | /// The EdgeMap handling is just a syntactical sugar. It writes |
---|
| 351 | /// two undirected edge map with '+' and '-' prefix in the name. |
---|
| 352 | /// |
---|
[1946] | 353 | ///\code |
---|
[1421] | 354 | /// writer.writeEdgeMap("capacity", capacityMap); |
---|
[1946] | 355 | ///\endcode |
---|
[1421] | 356 | /// |
---|
| 357 | /// |
---|
[1909] | 358 | /// With \c writeNode() and \c writeUEdge() functions you can |
---|
[1526] | 359 | /// designate nodes and undirected edges in the graph. For example, you can |
---|
[1421] | 360 | /// write out the source and target of the graph. |
---|
| 361 | /// |
---|
[1946] | 362 | ///\code |
---|
[1421] | 363 | /// writer.writeNode("source", sourceNode); |
---|
| 364 | /// writer.writeNode("target", targetNode); |
---|
| 365 | /// |
---|
[1909] | 366 | /// writer.writeUEdge("observed", uEdge); |
---|
[1946] | 367 | ///\endcode |
---|
[1421] | 368 | /// |
---|
| 369 | /// After you give all write commands you must call the \c run() member |
---|
[1526] | 370 | /// function, which executes all the writing commands. |
---|
[1421] | 371 | /// |
---|
[1946] | 372 | ///\code |
---|
[1421] | 373 | /// writer.run(); |
---|
[1946] | 374 | ///\endcode |
---|
[1421] | 375 | /// |
---|
| 376 | /// \see DefaultWriterTraits |
---|
| 377 | /// \see QuotedStringWriter |
---|
| 378 | /// \see IdMap |
---|
| 379 | /// \see DescriptorMap |
---|
| 380 | /// \see \ref GraphWriter |
---|
| 381 | /// \see \ref graph-io-page |
---|
| 382 | /// \author Balazs Dezso |
---|
| 383 | template <typename _Graph, typename _WriterTraits = DefaultWriterTraits> |
---|
[1909] | 384 | class UGraphWriter { |
---|
[1421] | 385 | public: |
---|
| 386 | |
---|
| 387 | typedef _Graph Graph; |
---|
| 388 | typedef typename Graph::Node Node; |
---|
| 389 | typedef typename Graph::Edge Edge; |
---|
[1909] | 390 | typedef typename Graph::UEdge UEdge; |
---|
[1421] | 391 | |
---|
| 392 | typedef _WriterTraits WriterTraits; |
---|
| 393 | |
---|
[1909] | 394 | /// \brief Construct a new UGraphWriter. |
---|
[1421] | 395 | /// |
---|
[1909] | 396 | /// Construct a new UGraphWriter. It writes the given graph |
---|
[1421] | 397 | /// to the given stream. |
---|
[1909] | 398 | UGraphWriter(std::ostream& _os, const Graph& _graph) |
---|
[1421] | 399 | : writer(new LemonWriter(_os)), own_writer(true), |
---|
| 400 | nodeset_writer(*writer, _graph, std::string()), |
---|
[2467] | 401 | uedgeset_writer(*writer, _graph, nodeset_writer, std::string()), |
---|
[1421] | 402 | node_writer(*writer, nodeset_writer, std::string()), |
---|
[2467] | 403 | uedge_writer(*writer, uedgeset_writer, std::string()), |
---|
[1421] | 404 | attribute_writer(*writer, std::string()) {} |
---|
| 405 | |
---|
[1909] | 406 | /// \brief Construct a new UGraphWriter. |
---|
[1421] | 407 | /// |
---|
[1909] | 408 | /// Construct a new UGraphWriter. It writes the given graph |
---|
[1421] | 409 | /// to the given file. |
---|
[1909] | 410 | UGraphWriter(const std::string& _filename, const Graph& _graph) |
---|
[1421] | 411 | : writer(new LemonWriter(_filename)), own_writer(true), |
---|
| 412 | nodeset_writer(*writer, _graph, std::string()), |
---|
[2467] | 413 | uedgeset_writer(*writer, _graph, nodeset_writer, std::string()), |
---|
[1421] | 414 | node_writer(*writer, nodeset_writer, std::string()), |
---|
[2467] | 415 | uedge_writer(*writer, uedgeset_writer, std::string()), |
---|
[1421] | 416 | attribute_writer(*writer, std::string()) {} |
---|
| 417 | |
---|
[1909] | 418 | /// \brief Construct a new UGraphWriter. |
---|
[1421] | 419 | /// |
---|
[1909] | 420 | /// Construct a new UGraphWriter. It writes the given graph |
---|
[2467] | 421 | /// to given LemonWriter. |
---|
[1909] | 422 | UGraphWriter(LemonWriter& _writer, const Graph& _graph) |
---|
[1421] | 423 | : writer(_writer), own_writer(false), |
---|
| 424 | nodeset_writer(*writer, _graph, std::string()), |
---|
[2467] | 425 | uedgeset_writer(*writer, _graph, nodeset_writer, std::string()), |
---|
[1421] | 426 | node_writer(*writer, nodeset_writer, std::string()), |
---|
[2467] | 427 | uedge_writer(*writer, uedgeset_writer, std::string()), |
---|
[1421] | 428 | attribute_writer(*writer, std::string()) {} |
---|
| 429 | |
---|
| 430 | /// \brief Destruct the graph writer. |
---|
| 431 | /// |
---|
| 432 | /// Destruct the graph writer. |
---|
[1909] | 433 | ~UGraphWriter() { |
---|
[1421] | 434 | if (own_writer) |
---|
| 435 | delete writer; |
---|
| 436 | } |
---|
| 437 | |
---|
[1526] | 438 | /// \brief Issue a new node map writing command to the writer. |
---|
[1421] | 439 | /// |
---|
[2200] | 440 | /// This function issues a new <i> node map writing command</i> to |
---|
| 441 | /// the writer. |
---|
[1421] | 442 | template <typename Map> |
---|
[2386] | 443 | UGraphWriter& writeNodeMap(std::string label, const Map& map) { |
---|
| 444 | nodeset_writer.writeNodeMap(label, map); |
---|
[1421] | 445 | return *this; |
---|
| 446 | } |
---|
| 447 | |
---|
[1526] | 448 | /// \brief Issue a new node map writing command to the writer. |
---|
[1421] | 449 | /// |
---|
[2200] | 450 | /// This function issues a new <i> node map writing command</i> to |
---|
| 451 | /// the writer. |
---|
[2386] | 452 | template <typename ItemWriter, typename Map> |
---|
| 453 | UGraphWriter& writeNodeMap(std::string label, const Map& map, |
---|
| 454 | const ItemWriter& iw = ItemWriter()) { |
---|
| 455 | nodeset_writer.writeNodeMap(label, map, iw); |
---|
[1421] | 456 | return *this; |
---|
| 457 | } |
---|
| 458 | |
---|
[1526] | 459 | /// \brief Issue a new edge map writing command to the writer. |
---|
[1421] | 460 | /// |
---|
[2200] | 461 | /// This function issues a new <i> edge map writing command</i> to |
---|
| 462 | /// the writer. |
---|
[1421] | 463 | template <typename Map> |
---|
[2386] | 464 | UGraphWriter& writeEdgeMap(std::string label, const Map& map) { |
---|
[2467] | 465 | uedgeset_writer.writeEdgeMap(label, map); |
---|
[1421] | 466 | return *this; |
---|
| 467 | } |
---|
| 468 | |
---|
[1526] | 469 | /// \brief Issue a new edge map writing command to the writer. |
---|
[1421] | 470 | /// |
---|
[2200] | 471 | /// This function issues a new <i> edge map writing command</i> to |
---|
| 472 | /// the writer. |
---|
[2386] | 473 | template <typename ItemWriter, typename Map> |
---|
| 474 | UGraphWriter& writeEdgeMap(std::string label, const Map& map, |
---|
| 475 | const ItemWriter& iw = ItemWriter()) { |
---|
[2467] | 476 | uedgeset_writer.writeEdgeMap(label, map, iw); |
---|
[1421] | 477 | return *this; |
---|
| 478 | } |
---|
| 479 | |
---|
[1526] | 480 | /// \brief Issue a new undirected edge map writing command to the writer. |
---|
[1421] | 481 | /// |
---|
[1526] | 482 | /// This function issues a new <i> undirected edge map writing |
---|
| 483 | /// command</i> to the writer. |
---|
[1421] | 484 | template <typename Map> |
---|
[2386] | 485 | UGraphWriter& writeUEdgeMap(std::string label, const Map& map) { |
---|
[2467] | 486 | uedgeset_writer.writeUEdgeMap(label, map); |
---|
[1421] | 487 | return *this; |
---|
| 488 | } |
---|
| 489 | |
---|
[1526] | 490 | /// \brief Issue a new undirected edge map writing command to the writer. |
---|
[1421] | 491 | /// |
---|
[1526] | 492 | /// This function issues a new <i> undirected edge map writing |
---|
| 493 | /// command</i> to the writer. |
---|
[2386] | 494 | template <typename ItemWriter, typename Map> |
---|
| 495 | UGraphWriter& writeUEdgeMap(std::string label, const Map& map, |
---|
| 496 | const ItemWriter& iw = ItemWriter()) { |
---|
[2467] | 497 | uedgeset_writer.writeUEdgeMap(label, map, iw); |
---|
[1421] | 498 | return *this; |
---|
| 499 | } |
---|
| 500 | |
---|
[1526] | 501 | /// \brief Issue a new labeled node writer to the writer. |
---|
[1421] | 502 | /// |
---|
[1526] | 503 | /// This function issues a new <i> labeled node writing |
---|
| 504 | /// command</i> to the writer. |
---|
[2386] | 505 | UGraphWriter& writeNode(std::string label, const Node& node) { |
---|
| 506 | node_writer.writeNode(label, node); |
---|
[1421] | 507 | return *this; |
---|
| 508 | } |
---|
| 509 | |
---|
[1526] | 510 | /// \brief Issue a new labeled edge writer to the writer. |
---|
[1421] | 511 | /// |
---|
[1526] | 512 | /// This function issues a new <i> labeled edge writing |
---|
| 513 | /// command</i> to the writer. |
---|
[2386] | 514 | UGraphWriter& writeEdge(std::string label, const Edge& edge) { |
---|
[2467] | 515 | uedge_writer.writeEdge(label, edge); |
---|
[1429] | 516 | } |
---|
| 517 | |
---|
[1526] | 518 | /// \brief Issue a new labeled undirected edge writing command to |
---|
| 519 | /// the writer. |
---|
[1429] | 520 | /// |
---|
[1526] | 521 | /// Issue a new <i>labeled undirected edge writing command</i> to |
---|
| 522 | /// the writer. |
---|
[2386] | 523 | UGraphWriter& writeUEdge(std::string label, const UEdge& edge) { |
---|
[2467] | 524 | uedge_writer.writeUEdge(label, edge); |
---|
[1421] | 525 | } |
---|
| 526 | |
---|
[1526] | 527 | /// \brief Issue a new attribute writing command. |
---|
[1421] | 528 | /// |
---|
[1526] | 529 | /// This function issues a new <i> attribute writing |
---|
| 530 | /// command</i> to the writer. |
---|
[1421] | 531 | template <typename Value> |
---|
[2386] | 532 | UGraphWriter& writeAttribute(std::string label, const Value& value) { |
---|
| 533 | attribute_writer.writeAttribute(label, value); |
---|
[1421] | 534 | return *this; |
---|
| 535 | } |
---|
| 536 | |
---|
[1526] | 537 | /// \brief Issue a new attribute writing command. |
---|
[1421] | 538 | /// |
---|
[1526] | 539 | /// This function issues a new <i> attribute writing |
---|
| 540 | /// command</i> to the writer. |
---|
[2386] | 541 | template <typename ItemWriter, typename Value> |
---|
| 542 | UGraphWriter& writeAttribute(std::string label, const Value& value, |
---|
| 543 | const ItemWriter& iw = ItemWriter()) { |
---|
| 544 | attribute_writer.writeAttribute(label, value, iw); |
---|
[1421] | 545 | return *this; |
---|
| 546 | } |
---|
| 547 | |
---|
| 548 | /// \brief Conversion operator to LemonWriter. |
---|
| 549 | /// |
---|
[1526] | 550 | /// Conversion operator to LemonWriter. It makes possible |
---|
[1421] | 551 | /// to access the encapsulated \e LemonWriter, this way |
---|
| 552 | /// you can attach to this writer new instances of |
---|
| 553 | /// \e LemonWriter::SectionWriter. |
---|
| 554 | operator LemonWriter&() { |
---|
| 555 | return *writer; |
---|
| 556 | } |
---|
| 557 | |
---|
[1526] | 558 | /// \brief Executes the writing commands. |
---|
[1421] | 559 | /// |
---|
[1526] | 560 | /// Executes the writing commands. |
---|
[1421] | 561 | void run() { |
---|
| 562 | writer->run(); |
---|
| 563 | } |
---|
| 564 | |
---|
[2467] | 565 | /// \brief Returns true if the writer can give back the labels by the items. |
---|
| 566 | /// |
---|
| 567 | /// Returns true if the writer can give back the the labels by the items. |
---|
| 568 | bool isLabelWriter() const { |
---|
| 569 | return nodeset_writer.isLabelWriter() && |
---|
| 570 | uedgeset_writer.isLabelWriter(); |
---|
| 571 | } |
---|
| 572 | |
---|
[1901] | 573 | /// \brief Write the label of the given node. |
---|
[1429] | 574 | /// |
---|
[2467] | 575 | /// It writes the label of the given node. If there was written a "label" |
---|
[1526] | 576 | /// named node map then it will write the map value belonging to the node. |
---|
[1901] | 577 | void writeLabel(std::ostream& os, const Node& item) const { |
---|
| 578 | nodeset_writer.writeLabel(os, item); |
---|
[1429] | 579 | } |
---|
| 580 | |
---|
[1901] | 581 | /// \brief Write the label of the given edge. |
---|
[1429] | 582 | /// |
---|
[2467] | 583 | /// It writes the label of the given edge. If there was written a "label" |
---|
[1526] | 584 | /// named edge map then it will write the map value belonging to the edge. |
---|
[1901] | 585 | void writeLabel(std::ostream& os, const Edge& item) const { |
---|
[2467] | 586 | uedgeset_writer.writeLabel(os, item); |
---|
[1429] | 587 | } |
---|
| 588 | |
---|
[1901] | 589 | /// \brief Write the label of the given undirected edge. |
---|
[1429] | 590 | /// |
---|
[2200] | 591 | /// It writes the label of the given undirected edge. If there was |
---|
[2467] | 592 | /// written a "label" named edge map then it will write the map |
---|
[2200] | 593 | /// value belonging to the edge. |
---|
[1909] | 594 | void writeLabel(std::ostream& os, const UEdge& item) const { |
---|
[2467] | 595 | uedgeset_writer.writeLabel(os, item); |
---|
[1429] | 596 | } |
---|
| 597 | |
---|
[2467] | 598 | /// \brief Sorts the given node vector by label. |
---|
| 599 | /// |
---|
| 600 | /// Sorts the given node vector by label. If there was written an |
---|
| 601 | /// "label" named map then the vector will be sorted by the values |
---|
| 602 | /// of this map. Otherwise if the \c forceLabel parameter was true |
---|
| 603 | /// it will be sorted by its id in the graph. |
---|
| 604 | void sortByLabel(std::vector<Node>& nodes) const { |
---|
| 605 | nodeset_writer.sortByLabel(nodes); |
---|
| 606 | } |
---|
| 607 | |
---|
| 608 | /// \brief Sorts the given edge vector by label. |
---|
| 609 | /// |
---|
| 610 | /// Sorts the given edge vector by label. If there was written an |
---|
| 611 | /// "label" named map then the vector will be sorted by the values |
---|
| 612 | /// of this map. Otherwise if the \c forceLabel parameter was true |
---|
| 613 | /// it will be sorted by its id in the graph. |
---|
| 614 | void sortByLabel(std::vector<Edge>& edges) const { |
---|
| 615 | uedgeset_writer.sortByLabel(edges); |
---|
| 616 | } |
---|
| 617 | |
---|
| 618 | /// \brief Sorts the given undirected edge vector by label. |
---|
| 619 | /// |
---|
| 620 | /// Sorts the given undirected edge vector by label. If there was |
---|
| 621 | /// written an "label" named map then the vector will be sorted by |
---|
| 622 | /// the values of this map. Otherwise if the \c forceLabel |
---|
| 623 | /// parameter was true it will be sorted by its id in the graph. |
---|
| 624 | void sortByLabel(std::vector<UEdge>& uedges) const { |
---|
| 625 | uedgeset_writer.sortByLabel(uedges); |
---|
| 626 | } |
---|
[1429] | 627 | |
---|
[1421] | 628 | private: |
---|
| 629 | |
---|
| 630 | LemonWriter* writer; |
---|
| 631 | bool own_writer; |
---|
| 632 | |
---|
| 633 | NodeSetWriter<Graph, WriterTraits> nodeset_writer; |
---|
[2467] | 634 | UEdgeSetWriter<Graph, WriterTraits> uedgeset_writer; |
---|
[1421] | 635 | |
---|
| 636 | NodeWriter<Graph> node_writer; |
---|
[2467] | 637 | UEdgeWriter<Graph> uedge_writer; |
---|
[1421] | 638 | |
---|
| 639 | AttributeWriter<WriterTraits> attribute_writer; |
---|
| 640 | }; |
---|
| 641 | |
---|
[1333] | 642 | /// @} |
---|
[1137] | 643 | |
---|
| 644 | } |
---|
[1214] | 645 | |
---|
| 646 | #endif |
---|