Changeset 313:64f8f7cc6168 in lemon
- Timestamp:
- 10/09/08 10:09:44 (16 years ago)
- Branch:
- default
- Phase:
- public
- Files:
-
- 16 edited
Legend:
- Unmodified
- Added
- Removed
-
demo/graph_to_eps_demo.cc
r220 r313 27 27 /// how to handle parallel egdes, how to change the properties (like 28 28 /// color, shape, size, title etc.) of nodes and arcs individually 29 /// using appropriate \ref maps-page "graph maps".29 /// using appropriate graph maps. 30 30 /// 31 31 /// \include graph_to_eps_demo.cc -
doc/lgf.dox
r236 r313 79 79 \endcode 80 80 81 The \c \@edges is just a synonym of \c \@arcs. The @arcs section can81 The \c \@edges is just a synonym of \c \@arcs. The \@arcs section can 82 82 also store the edge set of an undirected graph. In such case there is 83 83 a conventional method for store arc maps in the file, if two columns -
lemon/bits/alteration_notifier.h
r236 r313 80 80 /// be rolled back by calling the \e erase() or \e clear() 81 81 /// functions. Thence the \e erase() and \e clear() should not throw 82 /// exception. Actullay, it can be throw only 83 /// \ref AlterationObserver::ImmediateDetach ImmediateDetach 82 /// exception. Actullay, it can be throw only \ref ImmediateDetach 84 83 /// exception which detach the observer from the notifier. 85 84 /// -
lemon/bits/default_map.h
r209 r313 150 150 // #endif 151 151 152 /// \e152 /// DefaultMap class 153 153 template <typename _Graph, typename _Item, typename _Value> 154 154 class DefaultMap -
lemon/color.h
r209 r313 93 93 extern const Color DARK_CYAN; 94 94 95 ///Map <tt>int</tt>s to different \ref Color "Color"s95 ///Map <tt>int</tt>s to different <tt>Color</tt>s 96 96 97 97 ///This map assigns one of the predefined \ref Color "Color"s to -
lemon/concepts/graph_components.h
r263 r313 983 983 /// 984 984 /// This class describes the common interface of the graph maps 985 /// (NodeMap, ArcMap), that is \ref maps-page "maps" whichcan be used to985 /// (NodeMap, ArcMap), that is maps that can be used to 986 986 /// associate data to graph descriptors (nodes or arcs). 987 987 template <typename _Graph, typename _Item, typename _Value> -
lemon/core.h
r300 r313 1555 1555 ///structure is updated after each graph alteration. Thus although 1556 1556 ///this data structure is theoretically faster than \ref ArcLookUp 1557 ///and \ref AllArcLook up, it often provides worse performance than1557 ///and \ref AllArcLookUp, it often provides worse performance than 1558 1558 ///them. 1559 1559 Arc operator()(Node s, Node t, Arc p = INVALID) const { … … 1700 1700 ///Find an arc between two nodes. 1701 1701 1702 ///Find an arc between two nodes in time <em>O</em>(log<em>d</em>), where1703 /// <em>d</em> is the number of outgoing arcs of \c s.1702 ///Find an arc between two nodes in time <em>O</em>(log<em>d</em>), 1703 ///where <em>d</em> is the number of outgoing arcs of \c s. 1704 1704 ///\param s The source node. 1705 1705 ///\param t The target node. … … 1818 1818 ///\endcode 1819 1819 /// 1820 ///Finding the first arc take <em>O</em>(log<em>d</em>) time, where1821 /// <em>d</em> is the number of outgoing arcs of \c s. Then,the1820 ///Finding the first arc take <em>O</em>(log<em>d</em>) time, 1821 ///where <em>d</em> is the number of outgoing arcs of \c s. Then the 1822 1822 ///consecutive arcs are found in constant time. 1823 1823 /// -
lemon/dfs.h
r301 r313 836 836 }; 837 837 838 /// Default traits class used by \refDfsWizard838 /// Default traits class used by DfsWizard 839 839 840 840 /// To make it easier to use Dfs algorithm -
lemon/dijkstra.h
r301 r313 454 454 455 455 /// \brief \ref named-templ-param "Named parameter" for setting 456 ///\ refOperationTraits type456 ///\c OperationTraits type 457 457 /// 458 458 ///\ref named-templ-param "Named parameter" for setting … … 1039 1039 }; 1040 1040 1041 /// Default traits class used by \refDijkstraWizard1041 /// Default traits class used by DijkstraWizard 1042 1042 1043 1043 /// To make it easier to use Dijkstra algorithm -
lemon/dim2.h
r253 r313 260 260 261 261 262 /// Bounding box of plain vectors ( \ref Pointpoints).262 /// Bounding box of plain vectors (points). 263 263 264 264 /// A class to calculate or store the bounding box of plain vectors 265 /// (\ref Point points).265 /// (\ref Point "points"). 266 266 template<typename T> 267 267 class Box { … … 574 574 } 575 575 576 ///Map of x-coordinates of a \ref Point "Point"-map 577 578 ///\ingroup maps 576 ///Map of x-coordinates of a <tt>Point</tt>-map 577 579 578 ///Map of x-coordinates of a \ref Point "Point"-map. 580 /// 579 ///\ingroup maps 581 580 template<class M> 582 581 class XMap … … 593 592 }; 594 593 595 ///Returns an \refXMap class596 597 ///This function just returns an \refXMap class.594 ///Returns an XMap class 595 596 ///This function just returns an XMap class. 598 597 /// 599 598 ///\ingroup maps … … 611 610 } 612 611 613 ///Constant (read only) version of \ref XMap 614 615 ///\ingroup maps 616 ///Constant (read only) version of \ref XMap 617 /// 612 ///Constant (read only) version of XMap 613 614 ///Constant (read only) version of XMap. 615 ///\ingroup maps 618 616 template<class M> 619 617 class ConstXMap … … 629 627 }; 630 628 631 ///Returns a \refConstXMap class632 633 ///This function just returns a \refConstXMap class.629 ///Returns a ConstXMap class 630 631 ///This function just returns a ConstXMap class. 634 632 /// 635 633 ///\ingroup maps … … 641 639 } 642 640 643 ///Map of y-coordinates of a \ref Point "Point"-map 644 645 ///\ingroup maps 641 ///Map of y-coordinates of a <tt>Point</tt>-map 642 646 643 ///Map of y-coordinates of a \ref Point "Point"-map. 647 /// 644 ///\ingroup maps 648 645 template<class M> 649 646 class YMap … … 660 657 }; 661 658 662 ///Returns a \refYMap class663 664 ///This function just returns a \refYMap class.659 ///Returns a YMap class 660 661 ///This function just returns a YMap class. 665 662 /// 666 663 ///\ingroup maps … … 678 675 } 679 676 680 ///Constant (read only) version of \ref YMap 681 682 ///\ingroup maps 683 ///Constant (read only) version of \ref YMap 684 /// 677 ///Constant (read only) version of YMap 678 679 ///Constant (read only) version of YMap. 680 ///\ingroup maps 685 681 template<class M> 686 682 class ConstYMap … … 696 692 }; 697 693 698 ///Returns a \refConstYMap class699 700 ///This function just returns a \refConstYMap class.694 ///Returns a ConstYMap class 695 696 ///This function just returns a ConstYMap class. 701 697 /// 702 698 ///\ingroup maps … … 709 705 710 706 711 ///\brief Map of the \ref Point::normSquare() "normSquare()" 712 ///of a \ref Point "Point"-map 707 ///\brief Map of the normSquare() of a <tt>Point</tt>-map 713 708 /// 714 709 ///Map of the \ref Point::normSquare() "normSquare()" … … 728 723 }; 729 724 730 ///Returns a \refNormSquareMap class731 732 ///This function just returns a \refNormSquareMap class.725 ///Returns a NormSquareMap class 726 727 ///This function just returns a NormSquareMap class. 733 728 /// 734 729 ///\ingroup maps -
lemon/graph_to_eps.h
r291 r313 63 63 } 64 64 65 ///Default traits class of \refGraphToEps65 ///Default traits class of GraphToEps 66 66 67 67 ///Default traits class of \ref GraphToEps. -
lemon/list_graph.h
r280 r313 414 414 /// 415 415 ///\note The <tt>InArcIt</tt>s referencing the changed arc remain 416 ///valid. However the <tt>ArcIt< tt>s and <tt>OutArcIt</tt>s are416 ///valid. However the <tt>ArcIt</tt>s and <tt>OutArcIt</tt>s are 417 417 ///invalidated. 418 418 /// -
lemon/maps.h
r301 r313 44 44 class MapBase { 45 45 public: 46 /// \b iref The key type of the map.46 /// \brief The key type of the map. 47 47 typedef K Key; 48 48 /// \brief The value type of the map. … … 2267 2267 /// 2268 2268 /// Constructor 2269 /// \param _digraph The digraph that the map belongs to.2269 /// \param digraph The digraph that the map belongs to. 2270 2270 explicit SourceMap(const Digraph& digraph) : _digraph(digraph) {} 2271 2271 … … 2306 2306 /// 2307 2307 /// Constructor 2308 /// \param _digraph The digraph that the map belongs to.2308 /// \param digraph The digraph that the map belongs to. 2309 2309 explicit TargetMap(const Digraph& digraph) : _digraph(digraph) {} 2310 2310 … … 2345 2345 /// 2346 2346 /// Constructor 2347 /// \param _graph The graph that the map belongs to.2347 /// \param graph The graph that the map belongs to. 2348 2348 explicit ForwardMap(const Graph& graph) : _graph(graph) {} 2349 2349 … … 2384 2384 /// 2385 2385 /// Constructor 2386 /// \param _graph The graph that the map belongs to.2386 /// \param graph The graph that the map belongs to. 2387 2387 explicit BackwardMap(const Graph& graph) : _graph(graph) {} 2388 2388 -
lemon/path.h
r236 r313 850 850 int empty() const { return len == 0; } 851 851 852 /// \br eakErase all arcs in the digraph.852 /// \brief Erase all arcs in the digraph. 853 853 void clear() { 854 854 len = 0; -
lemon/smart_graph.h
r280 r313 366 366 367 367 ///This constructor immediately makes a snapshot of the digraph. 368 ///\param _gThe digraph we make a snapshot of.368 ///\param graph The digraph we make a snapshot of. 369 369 Snapshot(SmartDigraph &graph) : _graph(&graph) { 370 370 node_num=_graph->nodes.size(); … … 378 378 ///This function can be called more than once. In case of a repeated 379 379 ///call, the previous snapshot gets lost. 380 ///\param _gThe digraph we make the snapshot of.380 ///\param graph The digraph we make the snapshot of. 381 381 void save(SmartDigraph &graph) 382 382 { … … 776 776 777 777 ///This constructor immediately makes a snapshot of the digraph. 778 ///\param g The digraph we make a snapshot of.778 ///\param graph The digraph we make a snapshot of. 779 779 Snapshot(SmartGraph &graph) { 780 780 graph.saveSnapshot(*this); … … 787 787 ///This function can be called more than once. In case of a repeated 788 788 ///call, the previous snapshot gets lost. 789 ///\param g The digraph we make the snapshot of.789 ///\param graph The digraph we make the snapshot of. 790 790 void save(SmartGraph &graph) 791 791 { -
lemon/time_measure.h
r280 r313 312 312 ///Basically a Timer can be either running or stopped, 313 313 ///but it provides a bit finer control on the execution. 314 ///The \ref Timer also counts the number of \ref start()315 /// executions, and is stops only after the same amount (or more)316 /// \ref stop() "stop()"s. This can be useful e.g. to compute317 /// the running time314 ///The \ref lemon::Timer "Timer" also counts the number of 315 ///\ref lemon::Timer::start() "start()" executions, and it stops 316 ///only after the same amount (or more) \ref lemon::Timer::stop() 317 ///"stop()"s. This can be useful e.g. to compute the running time 318 318 ///of recursive functions. 319 ///320 319 321 320 ///@{ … … 473 472 }; 474 473 475 ///Same as \refTimer but prints a report on destruction.474 ///Same as Timer but prints a report on destruction. 476 475 477 476 ///Same as \ref Timer but prints a report on destruction. … … 492 491 std::ostream &_os; 493 492 public: 494 ///\e 495 493 ///Constructor 494 495 ///Constructor. 496 496 ///\param title This text will be printed before the ellapsed time. 497 497 ///\param os The stream to print the report to. 498 498 ///\param run Sets whether the timer should start immediately. 499 500 499 TimeReport(std::string title,std::ostream &os=std::cerr,bool run=true) 501 500 : Timer(run), _title(title), _os(os){} 502 /// \e Prints the ellapsed time on destruction.501 ///Destructor that prints the ellapsed time 503 502 ~TimeReport() 504 503 { … … 507 506 }; 508 507 509 ///'Do nothing' version of \refTimeReport508 ///'Do nothing' version of TimeReport 510 509 511 510 ///\sa TimeReport
Note: See TracChangeset
for help on using the changeset viewer.