simple_graph 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/docs/SimpleGraph/Graph/Node.html +497 -497
- data/docs/SimpleGraph/Graph.html +1123 -1123
- data/docs/SimpleGraph.html +146 -146
- data/docs/_index.html +136 -136
- data/docs/class_list.html +51 -51
- data/docs/css/full_list.css +58 -58
- data/docs/css/style.css +492 -492
- data/docs/file.README.html +154 -154
- data/docs/file_list.html +56 -56
- data/docs/frames.html +17 -17
- data/docs/index.html +154 -154
- data/docs/js/app.js +248 -248
- data/docs/js/full_list.js +216 -216
- data/docs/js/jquery.js +3 -3
- data/docs/method_list.html +203 -203
- data/docs/top-level-namespace.html +109 -109
- data/lib/simple_graph/version.rb +1 -1
- data/simple_graph.gemspec +2 -0
- metadata +23 -3
data/docs/file.README.html
CHANGED
@@ -1,155 +1,155 @@
|
|
1
|
-
<!DOCTYPE html>
|
2
|
-
<html>
|
3
|
-
<head>
|
4
|
-
<meta charset="UTF-8">
|
5
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
-
<title>
|
7
|
-
File: README
|
8
|
-
|
9
|
-
— Documentation by YARD 0.9.9
|
10
|
-
|
11
|
-
</title>
|
12
|
-
|
13
|
-
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
14
|
-
|
15
|
-
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
16
|
-
|
17
|
-
<script type="text/javascript" charset="utf-8">
|
18
|
-
pathId = "README";
|
19
|
-
relpath = '';
|
20
|
-
</script>
|
21
|
-
|
22
|
-
|
23
|
-
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
24
|
-
|
25
|
-
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
26
|
-
|
27
|
-
|
28
|
-
</head>
|
29
|
-
<body>
|
30
|
-
<div class="nav_wrap">
|
31
|
-
<iframe id="nav" src="file_list.html?1"></iframe>
|
32
|
-
<div id="resizer"></div>
|
33
|
-
</div>
|
34
|
-
|
35
|
-
<div id="main" tabindex="-1">
|
36
|
-
<div id="header">
|
37
|
-
<div id="menu">
|
38
|
-
|
39
|
-
<a href="_index.html">Index</a> »
|
40
|
-
<span class="title">File: README</span>
|
41
|
-
|
42
|
-
</div>
|
43
|
-
|
44
|
-
<div id="search">
|
45
|
-
|
46
|
-
<a class="full_list_link" id="class_list_link"
|
47
|
-
href="class_list.html">
|
48
|
-
|
49
|
-
<svg width="24" height="24">
|
50
|
-
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
51
|
-
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
52
|
-
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
-
</svg>
|
54
|
-
</a>
|
55
|
-
|
56
|
-
</div>
|
57
|
-
<div class="clear"></div>
|
58
|
-
</div>
|
59
|
-
|
60
|
-
<div id="content"><div id='filecontents'><h1>SimpleGraph</h1>
|
61
|
-
|
62
|
-
<p>A very basic graph gem for Ruby.</p>
|
63
|
-
|
64
|
-
<p>Currently only unweighted, undirected graphs are supported.
|
65
|
-
This means that multiple edges between nodes are ignored, although self loops are allowed.</p>
|
66
|
-
|
67
|
-
<h4>Warning</h4>
|
68
|
-
|
69
|
-
<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>
|
70
|
-
|
71
|
-
<h2>Installation</h2>
|
72
|
-
|
73
|
-
<p>Add this line to your application's Gemfile:</p>
|
74
|
-
|
75
|
-
<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>
|
76
|
-
</code></pre>
|
77
|
-
|
78
|
-
<p>And then execute:</p>
|
79
|
-
|
80
|
-
<pre class="code ruby"><code class="ruby">$ bundle
|
81
|
-
</code></pre>
|
82
|
-
|
83
|
-
<p>Or install it yourself as:</p>
|
84
|
-
|
85
|
-
<pre class="code ruby"><code class="ruby">$ gem install simple_graph
|
86
|
-
</code></pre>
|
87
|
-
|
88
|
-
<h2>Documentation</h2>
|
89
|
-
|
90
|
-
<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>
|
91
|
-
|
92
|
-
<h2>Usage</h2>
|
93
|
-
|
94
|
-
<h3>Quickstart</h3>
|
95
|
-
|
96
|
-
<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>
|
97
|
-
|
98
|
-
<span class='comment'># Creating a new, empty graph
|
99
|
-
</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>
|
100
|
-
|
101
|
-
<span class='comment'># Adding nodes to the graph
|
102
|
-
</span><span class='comment'># Creates a empty node containing only a autogenerated identifier
|
103
|
-
</span><span class='comment'># Returns a graph-unique identifier for the newly created node
|
104
|
-
</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>
|
105
|
-
<span class='comment'># IDs can also be set manually
|
106
|
-
</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>
|
107
|
-
<span class='comment'># Graphs can also hold arbitrary information in the 'data' hash
|
108
|
-
</span><span class='id identifier rubyid_stuff'>stuff</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
109
|
-
<span class='label'>age:</span> <span class='int'>21</span><span class='comma'>,</span>
|
110
|
-
<span class='label'>depression:</span> <span class='kw'>true</span>
|
111
|
-
<span class='rbrace'>}</span>
|
112
|
-
<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>
|
113
|
-
|
114
|
-
<span class='comment'># Edges can be created by passing the two node IDs to the connect_nodes method
|
115
|
-
</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>
|
116
|
-
|
117
|
-
<span class='comment'># Paths between two nodes can be found by breadth-first search
|
118
|
-
</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>
|
119
|
-
|
120
|
-
<span class='comment'># Retrieving info about the graph
|
121
|
-
</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
|
122
|
-
</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
|
123
|
-
</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
|
124
|
-
</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
|
125
|
-
</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
|
126
|
-
</span>
|
127
|
-
<span class='comment'># Graphs can be written to files in the DOT format to be used with Graphviz
|
128
|
-
</span><span class='comment'># Note that the node ID will be used for labels
|
129
|
-
</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>
|
130
|
-
|
131
|
-
<span class='comment'># Export a graph to a JSON file
|
132
|
-
</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>
|
133
|
-
|
134
|
-
<span class='comment'># Import a graph from a JSON file
|
135
|
-
</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>
|
136
|
-
</code></pre>
|
137
|
-
|
138
|
-
<h2>Contributing</h2>
|
139
|
-
|
140
|
-
<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>
|
141
|
-
|
142
|
-
<h2>License</h2>
|
143
|
-
|
144
|
-
<p>The gem is available as open source under the terms of the <a href="http://opensource.org/licenses/MIT">MIT License</a>.</p>
|
145
|
-
</div></div>
|
146
|
-
|
147
|
-
<div id="footer">
|
148
|
-
Generated on
|
149
|
-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
150
|
-
0.9.9 (ruby-2.3.1).
|
151
|
-
</div>
|
152
|
-
|
153
|
-
</div>
|
154
|
-
</body>
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="UTF-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
+
<title>
|
7
|
+
File: README
|
8
|
+
|
9
|
+
— Documentation by YARD 0.9.9
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
pathId = "README";
|
19
|
+
relpath = '';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
24
|
+
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
26
|
+
|
27
|
+
|
28
|
+
</head>
|
29
|
+
<body>
|
30
|
+
<div class="nav_wrap">
|
31
|
+
<iframe id="nav" src="file_list.html?1"></iframe>
|
32
|
+
<div id="resizer"></div>
|
33
|
+
</div>
|
34
|
+
|
35
|
+
<div id="main" tabindex="-1">
|
36
|
+
<div id="header">
|
37
|
+
<div id="menu">
|
38
|
+
|
39
|
+
<a href="_index.html">Index</a> »
|
40
|
+
<span class="title">File: README</span>
|
41
|
+
|
42
|
+
</div>
|
43
|
+
|
44
|
+
<div id="search">
|
45
|
+
|
46
|
+
<a class="full_list_link" id="class_list_link"
|
47
|
+
href="class_list.html">
|
48
|
+
|
49
|
+
<svg width="24" height="24">
|
50
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
51
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
52
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
+
</svg>
|
54
|
+
</a>
|
55
|
+
|
56
|
+
</div>
|
57
|
+
<div class="clear"></div>
|
58
|
+
</div>
|
59
|
+
|
60
|
+
<div id="content"><div id='filecontents'><h1>SimpleGraph</h1>
|
61
|
+
|
62
|
+
<p>A very basic graph gem for Ruby.</p>
|
63
|
+
|
64
|
+
<p>Currently only unweighted, undirected graphs are supported.
|
65
|
+
This means that multiple edges between nodes are ignored, although self loops are allowed.</p>
|
66
|
+
|
67
|
+
<h4>Warning</h4>
|
68
|
+
|
69
|
+
<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>
|
70
|
+
|
71
|
+
<h2>Installation</h2>
|
72
|
+
|
73
|
+
<p>Add this line to your application's Gemfile:</p>
|
74
|
+
|
75
|
+
<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>
|
76
|
+
</code></pre>
|
77
|
+
|
78
|
+
<p>And then execute:</p>
|
79
|
+
|
80
|
+
<pre class="code ruby"><code class="ruby">$ bundle
|
81
|
+
</code></pre>
|
82
|
+
|
83
|
+
<p>Or install it yourself as:</p>
|
84
|
+
|
85
|
+
<pre class="code ruby"><code class="ruby">$ gem install simple_graph
|
86
|
+
</code></pre>
|
87
|
+
|
88
|
+
<h2>Documentation</h2>
|
89
|
+
|
90
|
+
<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>
|
91
|
+
|
92
|
+
<h2>Usage</h2>
|
93
|
+
|
94
|
+
<h3>Quickstart</h3>
|
95
|
+
|
96
|
+
<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>
|
97
|
+
|
98
|
+
<span class='comment'># Creating a new, empty graph
|
99
|
+
</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>
|
100
|
+
|
101
|
+
<span class='comment'># Adding nodes to the graph
|
102
|
+
</span><span class='comment'># Creates a empty node containing only a autogenerated identifier
|
103
|
+
</span><span class='comment'># Returns a graph-unique identifier for the newly created node
|
104
|
+
</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>
|
105
|
+
<span class='comment'># IDs can also be set manually
|
106
|
+
</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>
|
107
|
+
<span class='comment'># Graphs can also hold arbitrary information in the 'data' hash
|
108
|
+
</span><span class='id identifier rubyid_stuff'>stuff</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
109
|
+
<span class='label'>age:</span> <span class='int'>21</span><span class='comma'>,</span>
|
110
|
+
<span class='label'>depression:</span> <span class='kw'>true</span>
|
111
|
+
<span class='rbrace'>}</span>
|
112
|
+
<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>
|
113
|
+
|
114
|
+
<span class='comment'># Edges can be created by passing the two node IDs to the connect_nodes method
|
115
|
+
</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>
|
116
|
+
|
117
|
+
<span class='comment'># Paths between two nodes can be found by breadth-first search
|
118
|
+
</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>
|
119
|
+
|
120
|
+
<span class='comment'># Retrieving info about the graph
|
121
|
+
</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
|
122
|
+
</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
|
123
|
+
</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
|
124
|
+
</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
|
125
|
+
</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
|
126
|
+
</span>
|
127
|
+
<span class='comment'># Graphs can be written to files in the DOT format to be used with Graphviz
|
128
|
+
</span><span class='comment'># Note that the node ID will be used for labels
|
129
|
+
</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>
|
130
|
+
|
131
|
+
<span class='comment'># Export a graph to a JSON file
|
132
|
+
</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>
|
133
|
+
|
134
|
+
<span class='comment'># Import a graph from a JSON file
|
135
|
+
</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>
|
136
|
+
</code></pre>
|
137
|
+
|
138
|
+
<h2>Contributing</h2>
|
139
|
+
|
140
|
+
<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>
|
141
|
+
|
142
|
+
<h2>License</h2>
|
143
|
+
|
144
|
+
<p>The gem is available as open source under the terms of the <a href="http://opensource.org/licenses/MIT">MIT License</a>.</p>
|
145
|
+
</div></div>
|
146
|
+
|
147
|
+
<div id="footer">
|
148
|
+
Generated on Wed Dec 6 15:09:43 2017 by
|
149
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
150
|
+
0.9.9 (ruby-2.3.1).
|
151
|
+
</div>
|
152
|
+
|
153
|
+
</div>
|
154
|
+
</body>
|
155
155
|
</html>
|
data/docs/file_list.html
CHANGED
@@ -1,56 +1,56 @@
|
|
1
|
-
<!DOCTYPE html>
|
2
|
-
<html>
|
3
|
-
<head>
|
4
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
5
|
-
<meta charset="utf-8" />
|
6
|
-
|
7
|
-
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
|
8
|
-
|
9
|
-
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
14
|
-
|
15
|
-
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
|
16
|
-
|
17
|
-
|
18
|
-
<title>File List</title>
|
19
|
-
<base id="base_target" target="_parent" />
|
20
|
-
</head>
|
21
|
-
<body>
|
22
|
-
<div id="content">
|
23
|
-
<div class="fixed_header">
|
24
|
-
<h1 id="full_list_header">File List</h1>
|
25
|
-
<div id="full_list_nav">
|
26
|
-
|
27
|
-
<span><a target="_self" href="class_list.html">
|
28
|
-
Classes
|
29
|
-
</a></span>
|
30
|
-
|
31
|
-
<span><a target="_self" href="method_list.html">
|
32
|
-
Methods
|
33
|
-
</a></span>
|
34
|
-
|
35
|
-
<span><a target="_self" href="file_list.html">
|
36
|
-
Files
|
37
|
-
</a></span>
|
38
|
-
|
39
|
-
</div>
|
40
|
-
|
41
|
-
<div id="search">Search: <input type="text" /></div>
|
42
|
-
</div>
|
43
|
-
|
44
|
-
<ul id="full_list" class="file">
|
45
|
-
|
46
|
-
|
47
|
-
<li id="object_README" class="odd">
|
48
|
-
<div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
|
49
|
-
</li>
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
</ul>
|
54
|
-
</div>
|
55
|
-
</body>
|
56
|
-
</html>
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
5
|
+
<meta charset="utf-8" />
|
6
|
+
|
7
|
+
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
|
8
|
+
|
9
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
10
|
+
|
11
|
+
|
12
|
+
|
13
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
14
|
+
|
15
|
+
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
|
16
|
+
|
17
|
+
|
18
|
+
<title>File List</title>
|
19
|
+
<base id="base_target" target="_parent" />
|
20
|
+
</head>
|
21
|
+
<body>
|
22
|
+
<div id="content">
|
23
|
+
<div class="fixed_header">
|
24
|
+
<h1 id="full_list_header">File List</h1>
|
25
|
+
<div id="full_list_nav">
|
26
|
+
|
27
|
+
<span><a target="_self" href="class_list.html">
|
28
|
+
Classes
|
29
|
+
</a></span>
|
30
|
+
|
31
|
+
<span><a target="_self" href="method_list.html">
|
32
|
+
Methods
|
33
|
+
</a></span>
|
34
|
+
|
35
|
+
<span><a target="_self" href="file_list.html">
|
36
|
+
Files
|
37
|
+
</a></span>
|
38
|
+
|
39
|
+
</div>
|
40
|
+
|
41
|
+
<div id="search">Search: <input type="text" /></div>
|
42
|
+
</div>
|
43
|
+
|
44
|
+
<ul id="full_list" class="file">
|
45
|
+
|
46
|
+
|
47
|
+
<li id="object_README" class="odd">
|
48
|
+
<div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
|
49
|
+
</li>
|
50
|
+
|
51
|
+
|
52
|
+
|
53
|
+
</ul>
|
54
|
+
</div>
|
55
|
+
</body>
|
56
|
+
</html>
|
data/docs/frames.html
CHANGED
@@ -1,17 +1,17 @@
|
|
1
|
-
<!DOCTYPE html>
|
2
|
-
<html>
|
3
|
-
<head>
|
4
|
-
<meta charset="utf-8">
|
5
|
-
<title>Documentation by YARD 0.9.9</title>
|
6
|
-
</head>
|
7
|
-
<script type="text/javascript" charset="utf-8">
|
8
|
-
var match = unescape(window.location.hash).match(/^#!(.+)/);
|
9
|
-
var name = match ? match[1] : 'index.html';
|
10
|
-
name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
|
11
|
-
window.top.location = name;
|
12
|
-
</script>
|
13
|
-
<noscript>
|
14
|
-
<h1>Oops!</h1>
|
15
|
-
<h2>YARD requires JavaScript!</h2>
|
16
|
-
</noscript>
|
17
|
-
</html>
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="utf-8">
|
5
|
+
<title>Documentation by YARD 0.9.9</title>
|
6
|
+
</head>
|
7
|
+
<script type="text/javascript" charset="utf-8">
|
8
|
+
var match = unescape(window.location.hash).match(/^#!(.+)/);
|
9
|
+
var name = match ? match[1] : 'index.html';
|
10
|
+
name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
|
11
|
+
window.top.location = name;
|
12
|
+
</script>
|
13
|
+
<noscript>
|
14
|
+
<h1>Oops!</h1>
|
15
|
+
<h2>YARD requires JavaScript!</h2>
|
16
|
+
</noscript>
|
17
|
+
</html>
|