<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
File: README
— Documentation by YARD 0.9.9
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
pathId = "README";
relpath = '';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index</a> »
<span class="title">File: README</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><div id='filecontents'><h1>SimpleGraph</h1>
<p>A very basic graph gem for Ruby.</p>
<p>Currently only unweighted, undirected graphs are supported.
This means that multiple edges between nodes are ignored, although self loops are allowed.</p>
<h4>Warning</h4>
<p>Note that this is a very early version, and everything about this library is subject to change at any given time without notice. Expect breaking changes.</p>
<h2>Installation</h2>
<p>Add this line to your application's Gemfile:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>simple_graph</span><span class='tstring_end'>'</span></span>
</code></pre>
<p>And then execute:</p>
<pre class="code ruby"><code class="ruby">$ bundle
</code></pre>
<p>Or install it yourself as:</p>
<pre class="code ruby"><code class="ruby">$ gem install simple_graph
</code></pre>
<h2>Documentation</h2>
<p>Docs are built using YARD and are available at <a href="https://vesther.github.io/simple_graph/">https://vesther.github.io/simple_graph/</a></p>
<h2>Usage</h2>
<h3>Quickstart</h3>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>simple_graph</span><span class='tstring_end'>"</span></span>
<span class='comment'># Creating a new, empty graph
</span><span class='id identifier rubyid_graph'>graph</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="SimpleGraph.html" title="SimpleGraph (module)">SimpleGraph</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="SimpleGraph/Graph.html" title="SimpleGraph::Graph (class)">Graph</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="SimpleGraph/Graph.html#initialize-instance_method" title="SimpleGraph::Graph#initialize (method)">new</a></span></span>
<span class='comment'># Adding nodes to the graph
</span><span class='comment'># Creates a empty node containing only a autogenerated identifier
</span><span class='comment'># Returns a graph-unique identifier for the newly created node
</span><span class='id identifier rubyid_foo'>foo</span> <span class='op'>=</span> <span class='id identifier rubyid_graph'>graph</span><span class='period'>.</span><span class='id identifier rubyid_add_node'>add_node</span><span class='lparen'>(</span><span class='rparen'>)</span>
<span class='comment'># IDs can also be set manually
</span><span class='id identifier rubyid_graph'>graph</span><span class='period'>.</span><span class='id identifier rubyid_add_node'>add_node</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Kevin</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='comment'># Graphs can also hold arbitrary information in the 'data' hash
</span><span class='id identifier rubyid_stuff'>stuff</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>age:</span> <span class='int'>21</span><span class='comma'>,</span>
<span class='label'>depression:</span> <span class='kw'>true</span>
<span class='rbrace'>}</span>
<span class='id identifier rubyid_bar'>bar</span> <span class='op'>=</span> <span class='id identifier rubyid_graph'>graph</span><span class='period'>.</span><span class='id identifier rubyid_add_node'>add_node</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Igor</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_stuff'>stuff</span><span class='rparen'>)</span>
<span class='comment'># Edges can be created by passing the two node IDs to the connect_nodes method
</span><span class='id identifier rubyid_graph'>graph</span><span class='period'>.</span><span class='id identifier rubyid_connect_nodes'>connect_nodes</span><span class='lparen'>(</span><span class='id identifier rubyid_foo'>foo</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Kevin</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='comment'># Paths between two nodes can be found by breadth-first search
</span><span class='id identifier rubyid_paths'>paths</span> <span class='op'>=</span> <span class='id identifier rubyid_graph'>graph</span><span class='period'>.</span><span class='id identifier rubyid_find_paths'>find_paths</span><span class='lparen'>(</span><span class='id identifier rubyid_foo'>foo</span><span class='comma'>,</span> <span class='id identifier rubyid_bar'>bar</span><span class='rparen'>)</span>
<span class='comment'># Retrieving info about the graph
</span><span class='id identifier rubyid_graph'>graph</span><span class='period'>.</span><span class='id identifier rubyid_nodes'>nodes</span> <span class='comment'># Lists all of the nodes in the graph
</span><span class='id identifier rubyid_graph'>graph</span><span class='period'>.</span><span class='id identifier rubyid_node_count'>node_count</span> <span class='comment'># Returns the amount of nodes in the graph
</span><span class='id identifier rubyid_graph'>graph</span><span class='period'>.</span><span class='id identifier rubyid_node_ids'>node_ids</span> <span class='comment'># Array of node identifiers in the graph
</span><span class='id identifier rubyid_graph'>graph</span><span class='period'>.</span><span class='id identifier rubyid_are_connected?'>are_connected?</span><span class='lparen'>(</span><span class='id identifier rubyid_foo'>foo</span><span class='comma'>,</span> <span class='id identifier rubyid_bar'>bar</span><span class='rparen'>)</span> <span class='comment'># Checks whether two nodes are connected by an Edge
</span><span class='id identifier rubyid_graph'>graph</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Kevin</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='comment'># Checks whether the graph includes a node with the given ID
</span>
<span class='comment'># Graphs can be written to files in the DOT format to be used with Graphviz
</span><span class='comment'># Note that the node ID will be used for labels
</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>test.dot</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_graph'>graph</span><span class='period'>.</span><span class='id identifier rubyid_to_dot_string'>to_dot_string</span><span class='rparen'>)</span>
<span class='comment'># Export a graph to a JSON file
</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>output.json</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_graph'>graph</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
<span class='comment'># Import a graph from a JSON file
</span><span class='id identifier rubyid_graph'>graph</span><span class='period'>.</span><span class='id identifier rubyid_load_from_json'>load_from_json</span><span class='lparen'>(</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>input.json</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
</code></pre>
<h2>Contributing</h2>
<p>Bug reports and pull requests are welcome on GitHub at <a href="https://github.com/vesther/simple_graph">https://github.com/vesther/simple_graph</a>.</p>
<h2>License</h2>
<p>The gem is available as open source under the terms of the <a href="http://opensource.org/licenses/MIT">MIT License</a>.</p>
</div></div>
<div id="footer">
Generated on Fri Nov 24 04:49:18 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.3.1).
</div>
</div>
</body>
</html>