README in rgl-0.2.3 vs README in rgl-0.3.0

- old
+ new

@@ -81,11 +81,11 @@ The concepts of IncidenceGraph, AdjacencyGraph and VertexListGraph (see http://www.boost.org/libs/graph/doc/IncidenceGraph.html) are here bundled in the base graph module. Most methods of IncidenceGraph should be standard in the base module Graph. The complexity guarantees can not necessarily provided. See -http://www.boost.org/libs/graph/doc/graph_concepts.html +http://www.boost.org/libs/graph/doc/graph_concepts.html. == Installation RGL is depended on the stream[http://rgl.rubyforge.org/stream/files/README.html] library which can @@ -100,47 +100,53 @@ or directly with % gem install rgl -Use the correct version number for VERSION (e.g. 0.2.2). You may need root +Use the correct version number for VERSION (e.g. 0.2.x). You may need root privileges to install. === Running tests RGL comes with a Rakefile which automatically runs the tests. Goto the installation directory and start rake: % gem env Rubygems Environment: - - VERSION: 0.8.3 (0.8.3) + - VERSION: 0.9.0 (0.9.0) - INSTALLATION DIRECTORY: /usr/lib/ruby/gems/1.8 - GEM PATH: - /usr/lib/ruby/gems/1.8 - REMOTE SOURCES: - http://gems.rubyforge.org - % cd /usr/lib/ruby/gems/1.8/gems/rgl-0.2.2/ - % r40> rake - (in /usr/lib/ruby/gems/1.8/gems/rgl-0.2.2) - ruby1.8 -Ilib:tests -e0 -rtests/TestGraphXML -rtests/TestComponents -rtests/TestDirectedGraph -rtests/TestEdge -rtests/TestImplicit -rtests/TestTransitiveClosure -rtests/TestTraversal -rtests/TestUnDirectedGraph - Loaded suite -e + % cd /usr/lib/ruby/gems/1.8/gems/rgl-0.3.0/ + % rake + (in /usr/lib/ruby/gems/1.8/gems/rgl-0.3.0) + /usr/bin/ruby1.8 -Ilib:tests "/usr/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake/rake_test_loader.rb" "tests/TestTransitiveClosure.rb" "tests/TestComponents.rb" "tests/TestCycles.rb" "tests/TestDirectedGraph.rb" "tests/TestEdge.rb" "tests/TestGraph.rb" "tests/TestGraphXML.rb" "tests/TestImplicit.rb" "tests/TestUnDirectedGraph.rb" "tests/TestTraversal.rb" "tests/TestDot.rb" "tests/TestRdot.rb" + Loaded suite /usr/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake/rake_test_loader Started - ........................................................................................................ - Finished in 0.736444 seconds. + ...................................................................................................................................................... + Finished in 0.750958 seconds. - 40 tests, 421 assertions, 0 failures, 0 errors + 86 tests, 625 assertions, 0 failures, 0 errors + +=== Code coverage +Running rcov[http://eigenclass.org/hiki.rb?rcov] on the test suite generates this[link:coverage/index.html] result. + === Normal Installation You have to install stream library before. You can than install RGL with the following command: % ruby install.rb -from its distribution directory. +from its distribution directory. To uninstall it use + % ruby install.rb -u + == Example irb session with RGL irb> require 'rgl/adjacency' irb> dg=RGL::DirectedAdjacencyGraph[1,2 ,2,3 ,2,4, 4,5, 6,4, 1,6] # Use DOT to visualize this graph: @@ -183,11 +189,11 @@ irb> dg.remove_edge 4,2 true <em>Topological sort</em> is realized with as iterator: - require 'graph/topsort' + require 'rgl/topsort' irb> dg.topsort_iterator.to_a [1, 2, 3, 6, 4, 5] A more elaborated example showing <em>implicit graphs</em>: @@ -225,16 +231,20 @@ produces module_graph.jpg: link:../examples/module_graph.jpg Look for more in the examples directory (i.e. examples.rb[link:files/examples/examples_rb.html]). +== My del.icio.us links concerning RGL + +I collect some links to stuff around RGL at http://del.icio.us/monora/rgl. I +registered RGL at SWiK[http://swik.net/rgl]. + == Credits Many thanks to Robert Feldt which also worked on a graph library (http://rockit.sf.net/subprojects/graphr) who pointed me to BGL and many other -graph resources. Manuel Simoni found a subtle bug in a preliminary version -announced at http://rubygarden.com/ruby?RubyAlgorithmPackage/Graph. +graph resources. Robert kindly allowed to integrate his work on graphr, which I did not yet succeed. Especially his work to output graphs for GraphViz[http://www.research.att.com/sw/tools/graphviz/download.html] is much more elaborated than the minimal support in dot.rb. @@ -247,18 +257,20 @@ Dave Thomas for RDoc[http://rdoc.sourceforge.net] which generated what you read and matz for Ruby. Dave included in the latest version of RDoc (alpha9) the module dot/dot.rb which I use instead of Roberts module to visualize graphs (see rgl/dot.rb). +Jeremy Bopp, John Carter, Sascha Doerdelmann and Shawn Garbett for contributing +additions, test cases and bugfixes. + == Copying -RGL is Copyright (c) 2002,2004,2005 by Horst Duchene. It is free software, and may be -redistributed under the terms specified in the README file of the Ruby -distribution. +RGL is Copyright (c) 2002,2004,2005,2008 by Horst Duchene. It is free software, and may be +redistributed under the terms specified in the README file of the Ruby distribution. == Support -Please contact me at mailto:monora@users.sourceforge.net with bug reports +Please contact me at mailto:monora@gmail.com with bug reports suggestions, and other comments. If you send patches, it would help if they were in-line (not attachments) and generated using "diff -u".