bow_tfidf 0.1.1 → 0.1.2
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/.yardoc/checksums +6 -0
- data/.yardoc/complete +0 -0
- data/.yardoc/object_types +0 -0
- data/.yardoc/objects/root.dat +0 -0
- data/.yardoc/proxy_types +0 -0
- data/doc/BowTfidf.html +133 -0
- data/doc/BowTfidf/BagOfWords.html +437 -0
- data/doc/BowTfidf/Classifier.html +470 -0
- data/doc/BowTfidf/Computation.html +364 -0
- data/doc/BowTfidf/Tokenizer.html +407 -0
- data/doc/_index.html +151 -0
- data/doc/class_list.html +51 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +496 -0
- data/doc/file.README.html +244 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +17 -0
- data/doc/index.html +72 -0
- data/doc/js/app.js +303 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +163 -0
- data/doc/top-level-namespace.html +110 -0
- data/lib/bow_tfidf/classifier.rb +2 -2
- data/lib/bow_tfidf/version.rb +1 -1
- metadata +25 -3
- data/Gemfile.lock +0 -34
- data/bow_tfidf-0.1.0.gem +0 -0
|
@@ -0,0 +1,244 @@
|
|
|
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.19
|
|
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'>
|
|
61
|
+
<h1 id="label-BowTfidf">BowTfidf</h1>
|
|
62
|
+
|
|
63
|
+
<p>Based on two concepts TFIDF and Bag-of-words.</p>
|
|
64
|
+
|
|
65
|
+
<h3 id="label-TFIDF">TFIDF</h3>
|
|
66
|
+
|
|
67
|
+
<blockquote>
|
|
68
|
+
<p>TFIDF - In information retrieval, tf–idf or TFIDF, short for term
|
|
69
|
+
frequency–inverse document frequency, is a numerical statistic that is
|
|
70
|
+
intended to reflect how important a word is to a document in a collection
|
|
71
|
+
or corpus. It is often used as a weighting factor in searches of
|
|
72
|
+
information retrieval, text mining, and user modeling. The tf–idf value
|
|
73
|
+
increases proportionally to the number of times a word appears in the
|
|
74
|
+
document and is offset by the number of documents in the corpus that
|
|
75
|
+
contain the word, which helps to adjust for the fact that some words appear
|
|
76
|
+
more frequently in general. Tf–idf is one of the most popular
|
|
77
|
+
term-weighting schemes today; 83% of text-based recommender systems in
|
|
78
|
+
digital libraries use tf–idf. Variations of the tf–idf weighting scheme are
|
|
79
|
+
often used by search engines as a central tool in scoring and ranking a
|
|
80
|
+
document's relevance given a user query. tf–idf can be successfully
|
|
81
|
+
used for stop-words filtering in various subject fields, including text
|
|
82
|
+
summarization and classification.</p>
|
|
83
|
+
</blockquote>
|
|
84
|
+
|
|
85
|
+
<p>Read more about TFIDF on <a
|
|
86
|
+
href="https://en.wikipedia.org/wiki/Tf%E2%80%93idf">Wikipedia</a>.</p>
|
|
87
|
+
|
|
88
|
+
<h3 id="label-Bag-of-words.">Bag-of-words.</h3>
|
|
89
|
+
|
|
90
|
+
<blockquote>
|
|
91
|
+
<p>The bag-of-words model is a simplifying representation used in natural
|
|
92
|
+
language processing and information retrieval (IR). In this model, a text
|
|
93
|
+
(such as a sentence or a document) is represented as the bag (multiset) of
|
|
94
|
+
its words, disregarding grammar and even word order but keeping
|
|
95
|
+
multiplicity. The bag-of-words model has also been used for computer
|
|
96
|
+
vision. The bag-of-words model is commonly used in methods of document
|
|
97
|
+
classification where the (frequency of) occurrence of each word is used as
|
|
98
|
+
a feature for training a classifier.</p>
|
|
99
|
+
</blockquote>
|
|
100
|
+
|
|
101
|
+
<p>Read more about Bag-of-words on <a
|
|
102
|
+
href="https://en.wikipedia.org/wiki/Bag-of-words_model">Wikipedia</a>.</p>
|
|
103
|
+
|
|
104
|
+
<h2 id="label-Installation">Installation</h2>
|
|
105
|
+
|
|
106
|
+
<p>Add this line to your application's Gemfile:</p>
|
|
107
|
+
|
|
108
|
+
<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'>bow_tfidf</span><span class='tstring_end'>'</span></span>
|
|
109
|
+
</code></pre>
|
|
110
|
+
|
|
111
|
+
<p>And then execute:</p>
|
|
112
|
+
|
|
113
|
+
<pre class="code ruby"><code class="ruby">$ bundle</code></pre>
|
|
114
|
+
|
|
115
|
+
<p>Or install it yourself as:</p>
|
|
116
|
+
|
|
117
|
+
<pre class="code ruby"><code class="ruby">$ gem install bow_tfidf</code></pre>
|
|
118
|
+
|
|
119
|
+
<h2 id="label-Usage">Usage</h2>
|
|
120
|
+
|
|
121
|
+
<p>First of all bag of words with computed tfidf for each word should be
|
|
122
|
+
created. For this add labeled words as a hash to bag of words:</p>
|
|
123
|
+
|
|
124
|
+
<pre class="code ruby"><code class="ruby">bow = BowTfidf::BagOfWords.new
|
|
125
|
+
bow.add_labeled_data!({
|
|
126
|
+
category1: ['word', 'word1'],
|
|
127
|
+
category2: ['word', 'word2']
|
|
128
|
+
category3: ['word', 'word2', 'word3']
|
|
129
|
+
})
|
|
130
|
+
</code></pre>
|
|
131
|
+
|
|
132
|
+
<p>Instance of <code>BowTfidf::BagOfWords</code> responds to
|
|
133
|
+
<code>words</code> and <code>categories</code> methods: “`ruby bow.words</p>
|
|
134
|
+
|
|
135
|
+
<h1 id="label-7B">
|
|
136
|
+
<h1 id="label-27word1-27+-3D-3E+-7B">'word1' => {</h1>
|
|
137
|
+
|
|
138
|
+
<h1 id="label-categories-3A+-7B">categories: {</h1>
|
|
139
|
+
|
|
140
|
+
<h1 id="label-1+-3D-3E+-7B">1 => {</h1>
|
|
141
|
+
|
|
142
|
+
<h1 id="label-tf-3A+0.3010299956639812-2C">tf: 0.3010299956639812,</h1>
|
|
143
|
+
|
|
144
|
+
<h1 id="label-tfidf-3A+0.14362780923945326">tfidf: 0.14362780923945326</h1>
|
|
145
|
+
|
|
146
|
+
<h1 id="label-7D"></h1>
|
|
147
|
+
|
|
148
|
+
<h1 id="label-7D-2C">},</h1>
|
|
149
|
+
|
|
150
|
+
<h1 id="label-idf-3A+0.47712125471966244">idf: 0.47712125471966244</h1>
|
|
151
|
+
|
|
152
|
+
<h1 id="label-7D-2C">},</h1>
|
|
153
|
+
|
|
154
|
+
<h1 id="label-...">…</h1>
|
|
155
|
+
|
|
156
|
+
<h1 id="label-7D">}</h1>
|
|
157
|
+
|
|
158
|
+
<p>bow.categories</p>
|
|
159
|
+
|
|
160
|
+
<h1 id="label-7B">
|
|
161
|
+
<h1 id="label-category1-3A+-7B">category1: {</h1>
|
|
162
|
+
|
|
163
|
+
<h1 id="label-id-3A+1-2C">id: 1,</h1>
|
|
164
|
+
|
|
165
|
+
<h1 id="label-key-3A+-3Acategory1-2C">key: :category1,</h1>
|
|
166
|
+
|
|
167
|
+
<h1 id="label-words-3A+Set-5B-27word-27-2C+-27word1-27-5D">words: Set['word', 'word1']</h1>
|
|
168
|
+
|
|
169
|
+
<h1 id="label-7D-2C">,</h1>
|
|
170
|
+
|
|
171
|
+
<h1 id="label-...">…</h1>
|
|
172
|
+
|
|
173
|
+
<h1 id="label-7D">}</h1>
|
|
174
|
+
|
|
175
|
+
<pre class="code ruby"><code class="ruby">
|
|
176
|
+
To identify category of text pass array of words as argument to category classifier:</code></pre>
|
|
177
|
+
|
|
178
|
+
<p>ruby classifier = BowTfidf::Classifier.new(bow)
|
|
179
|
+
classifier.call(['word2' 'word3'])</p>
|
|
180
|
+
|
|
181
|
+
<h1 id="label-7B">
|
|
182
|
+
<h1 id="label-category_key-3A+-3Acategory3-2C">category_key: :category3,</h1>
|
|
183
|
+
|
|
184
|
+
<h1 id="label-score-3A+-7B">score: {</h1>
|
|
185
|
+
|
|
186
|
+
<h1 id="label-category3-3A+0.27185717486836963-2C">category3: 0.27185717486836963,</h1>
|
|
187
|
+
|
|
188
|
+
<h1 id="label-category2-3A+0.09061905828945654">category2: 0.09061905828945654</h1>
|
|
189
|
+
|
|
190
|
+
<h1 id="label-7D"></h1>
|
|
191
|
+
|
|
192
|
+
<h1 id="label-7D">}</h1>
|
|
193
|
+
|
|
194
|
+
<pre class="code ruby"><code class="ruby">`:category_key` - assumption about category of text by given words. Is based on `:score`. The highest score wins.
|
|
195
|
+
|
|
196
|
+
`BowTfidf::Classifier` takes numerical interpretation of relation beetwen word and category, sums it up for each word and returns score.
|
|
197
|
+
|
|
198
|
+
### When classifier cannot recognize category:
|
|
199
|
+
|
|
200
|
+
1. all given words not in the BOW.
|
|
201
|
+
- **Solution:** update BOW with new words.
|
|
202
|
+
|
|
203
|
+
2. each of given words belongs to all categories
|
|
204
|
+
- In current implementation TFIDF tool ignores such words and not adding it to BOW. It is done with assumption that less frequent words should exists.
|
|
205
|
+
|
|
206
|
+
### Performance
|
|
207
|
+
To improve performance and memmory usage create dump of built BOW with light data structure(without unnecessary for classifier attributes) and custom classifier which can work with the dump.
|
|
208
|
+
|
|
209
|
+
### Split text into words(tokens)</code></pre>
|
|
210
|
+
|
|
211
|
+
<p>ruby BowTfidf::Tokenizer.new.call('word word2, some! text')</p>
|
|
212
|
+
|
|
213
|
+
<h1 id="label-3CSet-3A+-7B-22word-22-2C+-22word2-22-2C+-22some-22-2C+-22text-22-7D-3E"><Set: “word2”, “some”, “text”></h1>
|
|
214
|
+
|
|
215
|
+
<p>“`</p>
|
|
216
|
+
|
|
217
|
+
<h2 id="label-Development">Development</h2>
|
|
218
|
+
|
|
219
|
+
<p>After checking out the repo, run <code>bin/setup</code> to install
|
|
220
|
+
dependencies. You can also run <code>bin/console</code> for an interactive
|
|
221
|
+
prompt that will allow you to experiment.</p>
|
|
222
|
+
|
|
223
|
+
<p>To install this gem onto your local machine, run <code>bundle exec rake
|
|
224
|
+
install</code>. To release a new version, update the version number in
|
|
225
|
+
<code>version.rb</code>, and then run <code>bundle exec rake
|
|
226
|
+
release</code>, which will create a git tag for the version, push git
|
|
227
|
+
commits and tags, and push the <code>.gem</code> file to <a
|
|
228
|
+
href="https://rubygems.org">rubygems.org</a>.</p>
|
|
229
|
+
|
|
230
|
+
<h2 id="label-Contributing">Contributing</h2>
|
|
231
|
+
|
|
232
|
+
<p>Bug reports and pull requests are welcome on GitHub at <a
|
|
233
|
+
href="https://github.com/isidzukuri/bow_tfidf">github.com/isidzukuri/bow_tfidf</a>.</p>
|
|
234
|
+
</div></div>
|
|
235
|
+
|
|
236
|
+
<div id="footer">
|
|
237
|
+
Generated on Tue Apr 9 12:45:14 2019 by
|
|
238
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
239
|
+
0.9.19 (ruby-2.1.2).
|
|
240
|
+
</div>
|
|
241
|
+
|
|
242
|
+
</div>
|
|
243
|
+
</body>
|
|
244
|
+
</html>
|
data/doc/file_list.html
ADDED
|
@@ -0,0 +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>
|
data/doc/frames.html
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<title>Documentation by YARD 0.9.19</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>
|
data/doc/index.html
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
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.19
|
|
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="class_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'>
|
|
61
|
+
<h1 id="label-BowTfidf">BowTfidf</h1>
|
|
62
|
+
</div>
|
|
63
|
+
|
|
64
|
+
<div id="footer">
|
|
65
|
+
Generated on Tue Apr 9 12:45:14 2019 by
|
|
66
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
67
|
+
0.9.19 (ruby-2.1.2).
|
|
68
|
+
</div>
|
|
69
|
+
|
|
70
|
+
</div>
|
|
71
|
+
</body>
|
|
72
|
+
</html>
|
data/doc/js/app.js
ADDED
|
@@ -0,0 +1,303 @@
|
|
|
1
|
+
(function() {
|
|
2
|
+
|
|
3
|
+
var localStorage = {}, sessionStorage = {};
|
|
4
|
+
try { localStorage = window.localStorage; } catch (e) { }
|
|
5
|
+
try { sessionStorage = window.sessionStorage; } catch (e) { }
|
|
6
|
+
|
|
7
|
+
function createSourceLinks() {
|
|
8
|
+
$('.method_details_list .source_code').
|
|
9
|
+
before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
|
|
10
|
+
$('.toggleSource').toggle(function() {
|
|
11
|
+
$(this).parent().nextAll('.source_code').slideDown(100);
|
|
12
|
+
$(this).text("Hide source");
|
|
13
|
+
},
|
|
14
|
+
function() {
|
|
15
|
+
$(this).parent().nextAll('.source_code').slideUp(100);
|
|
16
|
+
$(this).text("View source");
|
|
17
|
+
});
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
function createDefineLinks() {
|
|
21
|
+
var tHeight = 0;
|
|
22
|
+
$('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
|
|
23
|
+
$('.toggleDefines').toggle(function() {
|
|
24
|
+
tHeight = $(this).parent().prev().height();
|
|
25
|
+
$(this).prev().css('display', 'inline');
|
|
26
|
+
$(this).parent().prev().height($(this).parent().height());
|
|
27
|
+
$(this).text("(less)");
|
|
28
|
+
},
|
|
29
|
+
function() {
|
|
30
|
+
$(this).prev().hide();
|
|
31
|
+
$(this).parent().prev().height(tHeight);
|
|
32
|
+
$(this).text("more...");
|
|
33
|
+
});
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
function createFullTreeLinks() {
|
|
37
|
+
var tHeight = 0;
|
|
38
|
+
$('.inheritanceTree').toggle(function() {
|
|
39
|
+
tHeight = $(this).parent().prev().height();
|
|
40
|
+
$(this).parent().toggleClass('showAll');
|
|
41
|
+
$(this).text("(hide)");
|
|
42
|
+
$(this).parent().prev().height($(this).parent().height());
|
|
43
|
+
},
|
|
44
|
+
function() {
|
|
45
|
+
$(this).parent().toggleClass('showAll');
|
|
46
|
+
$(this).parent().prev().height(tHeight);
|
|
47
|
+
$(this).text("show all");
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
function searchFrameButtons() {
|
|
52
|
+
$('.full_list_link').click(function() {
|
|
53
|
+
toggleSearchFrame(this, $(this).attr('href'));
|
|
54
|
+
return false;
|
|
55
|
+
});
|
|
56
|
+
window.addEventListener('message', function(e) {
|
|
57
|
+
if (e.data === 'navEscape') {
|
|
58
|
+
$('#nav').slideUp(100);
|
|
59
|
+
$('#search a').removeClass('active inactive');
|
|
60
|
+
$(window).focus();
|
|
61
|
+
}
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
$(window).resize(function() {
|
|
65
|
+
if ($('#search:visible').length === 0) {
|
|
66
|
+
$('#nav').removeAttr('style');
|
|
67
|
+
$('#search a').removeClass('active inactive');
|
|
68
|
+
$(window).focus();
|
|
69
|
+
}
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
function toggleSearchFrame(id, link) {
|
|
74
|
+
var frame = $('#nav');
|
|
75
|
+
$('#search a').removeClass('active').addClass('inactive');
|
|
76
|
+
if (frame.attr('src') === link && frame.css('display') !== "none") {
|
|
77
|
+
frame.slideUp(100);
|
|
78
|
+
$('#search a').removeClass('active inactive');
|
|
79
|
+
}
|
|
80
|
+
else {
|
|
81
|
+
$(id).addClass('active').removeClass('inactive');
|
|
82
|
+
if (frame.attr('src') !== link) frame.attr('src', link);
|
|
83
|
+
frame.slideDown(100);
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
function linkSummaries() {
|
|
88
|
+
$('.summary_signature').click(function() {
|
|
89
|
+
document.location = $(this).find('a').attr('href');
|
|
90
|
+
});
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
function summaryToggle() {
|
|
94
|
+
$('.summary_toggle').click(function(e) {
|
|
95
|
+
e.preventDefault();
|
|
96
|
+
localStorage.summaryCollapsed = $(this).text();
|
|
97
|
+
$('.summary_toggle').each(function() {
|
|
98
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
|
99
|
+
var next = $(this).parent().parent().nextAll('ul.summary').first();
|
|
100
|
+
if (next.hasClass('compact')) {
|
|
101
|
+
next.toggle();
|
|
102
|
+
next.nextAll('ul.summary').first().toggle();
|
|
103
|
+
}
|
|
104
|
+
else if (next.hasClass('summary')) {
|
|
105
|
+
var list = $('<ul class="summary compact" />');
|
|
106
|
+
list.html(next.html());
|
|
107
|
+
list.find('.summary_desc, .note').remove();
|
|
108
|
+
list.find('a').each(function() {
|
|
109
|
+
$(this).html($(this).find('strong').html());
|
|
110
|
+
$(this).parent().html($(this)[0].outerHTML);
|
|
111
|
+
});
|
|
112
|
+
next.before(list);
|
|
113
|
+
next.toggle();
|
|
114
|
+
}
|
|
115
|
+
});
|
|
116
|
+
return false;
|
|
117
|
+
});
|
|
118
|
+
if (localStorage.summaryCollapsed == "collapse") {
|
|
119
|
+
$('.summary_toggle').first().click();
|
|
120
|
+
} else { localStorage.summaryCollapsed = "expand"; }
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
function constantSummaryToggle() {
|
|
124
|
+
$('.constants_summary_toggle').click(function(e) {
|
|
125
|
+
e.preventDefault();
|
|
126
|
+
localStorage.summaryCollapsed = $(this).text();
|
|
127
|
+
$('.constants_summary_toggle').each(function() {
|
|
128
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
|
129
|
+
var next = $(this).parent().parent().nextAll('dl.constants').first();
|
|
130
|
+
if (next.hasClass('compact')) {
|
|
131
|
+
next.toggle();
|
|
132
|
+
next.nextAll('dl.constants').first().toggle();
|
|
133
|
+
}
|
|
134
|
+
else if (next.hasClass('constants')) {
|
|
135
|
+
var list = $('<dl class="constants compact" />');
|
|
136
|
+
list.html(next.html());
|
|
137
|
+
list.find('dt').each(function() {
|
|
138
|
+
$(this).addClass('summary_signature');
|
|
139
|
+
$(this).text( $(this).text().split('=')[0]);
|
|
140
|
+
if ($(this).has(".deprecated").length) {
|
|
141
|
+
$(this).addClass('deprecated');
|
|
142
|
+
};
|
|
143
|
+
});
|
|
144
|
+
// Add the value of the constant as "Tooltip" to the summary object
|
|
145
|
+
list.find('pre.code').each(function() {
|
|
146
|
+
console.log($(this).parent());
|
|
147
|
+
var dt_element = $(this).parent().prev();
|
|
148
|
+
var tooltip = $(this).text();
|
|
149
|
+
if (dt_element.hasClass("deprecated")) {
|
|
150
|
+
tooltip = 'Deprecated. ' + tooltip;
|
|
151
|
+
};
|
|
152
|
+
dt_element.attr('title', tooltip);
|
|
153
|
+
});
|
|
154
|
+
list.find('.docstring, .tags, dd').remove();
|
|
155
|
+
next.before(list);
|
|
156
|
+
next.toggle();
|
|
157
|
+
}
|
|
158
|
+
});
|
|
159
|
+
return false;
|
|
160
|
+
});
|
|
161
|
+
if (localStorage.summaryCollapsed == "collapse") {
|
|
162
|
+
$('.constants_summary_toggle').first().click();
|
|
163
|
+
} else { localStorage.summaryCollapsed = "expand"; }
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
function generateTOC() {
|
|
167
|
+
if ($('#filecontents').length === 0) return;
|
|
168
|
+
var _toc = $('<ol class="top"></ol>');
|
|
169
|
+
var show = false;
|
|
170
|
+
var toc = _toc;
|
|
171
|
+
var counter = 0;
|
|
172
|
+
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
|
|
173
|
+
var i;
|
|
174
|
+
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
|
175
|
+
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
|
176
|
+
var lastTag = parseInt(tags[0][1], 10);
|
|
177
|
+
$(tags.join(', ')).each(function() {
|
|
178
|
+
if ($(this).parents('.method_details .docstring').length != 0) return;
|
|
179
|
+
if (this.id == "filecontents") return;
|
|
180
|
+
show = true;
|
|
181
|
+
var thisTag = parseInt(this.tagName[1], 10);
|
|
182
|
+
if (this.id.length === 0) {
|
|
183
|
+
var proposedId = $(this).attr('toc-id');
|
|
184
|
+
if (typeof(proposedId) != "undefined") this.id = proposedId;
|
|
185
|
+
else {
|
|
186
|
+
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
|
|
187
|
+
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
|
|
188
|
+
this.id = proposedId;
|
|
189
|
+
}
|
|
190
|
+
}
|
|
191
|
+
if (thisTag > lastTag) {
|
|
192
|
+
for (i = 0; i < thisTag - lastTag; i++) {
|
|
193
|
+
var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
|
|
194
|
+
}
|
|
195
|
+
}
|
|
196
|
+
if (thisTag < lastTag) {
|
|
197
|
+
for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
|
|
198
|
+
}
|
|
199
|
+
var title = $(this).attr('toc-title');
|
|
200
|
+
if (typeof(title) == "undefined") title = $(this).text();
|
|
201
|
+
toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
|
|
202
|
+
lastTag = thisTag;
|
|
203
|
+
});
|
|
204
|
+
if (!show) return;
|
|
205
|
+
html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
|
|
206
|
+
$('#content').prepend(html);
|
|
207
|
+
$('#toc').append(_toc);
|
|
208
|
+
$('#toc .hide_toc').toggle(function() {
|
|
209
|
+
$('#toc .top').slideUp('fast');
|
|
210
|
+
$('#toc').toggleClass('hidden');
|
|
211
|
+
$('#toc .title small').toggle();
|
|
212
|
+
}, function() {
|
|
213
|
+
$('#toc .top').slideDown('fast');
|
|
214
|
+
$('#toc').toggleClass('hidden');
|
|
215
|
+
$('#toc .title small').toggle();
|
|
216
|
+
});
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
function navResizeFn(e) {
|
|
220
|
+
if (e.which !== 1) {
|
|
221
|
+
navResizeFnStop();
|
|
222
|
+
return;
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
sessionStorage.navWidth = e.pageX.toString();
|
|
226
|
+
$('.nav_wrap').css('width', e.pageX);
|
|
227
|
+
$('.nav_wrap').css('-ms-flex', 'inherit');
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
function navResizeFnStop() {
|
|
231
|
+
$(window).unbind('mousemove', navResizeFn);
|
|
232
|
+
window.removeEventListener('message', navMessageFn, false);
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
function navMessageFn(e) {
|
|
236
|
+
if (e.data.action === 'mousemove') navResizeFn(e.data.event);
|
|
237
|
+
if (e.data.action === 'mouseup') navResizeFnStop();
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
function navResizer() {
|
|
241
|
+
$('#resizer').mousedown(function(e) {
|
|
242
|
+
e.preventDefault();
|
|
243
|
+
$(window).mousemove(navResizeFn);
|
|
244
|
+
window.addEventListener('message', navMessageFn, false);
|
|
245
|
+
});
|
|
246
|
+
$(window).mouseup(navResizeFnStop);
|
|
247
|
+
|
|
248
|
+
if (sessionStorage.navWidth) {
|
|
249
|
+
navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
|
|
250
|
+
}
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
function navExpander() {
|
|
254
|
+
var done = false, timer = setTimeout(postMessage, 500);
|
|
255
|
+
function postMessage() {
|
|
256
|
+
if (done) return;
|
|
257
|
+
clearTimeout(timer);
|
|
258
|
+
var opts = { action: 'expand', path: pathId };
|
|
259
|
+
document.getElementById('nav').contentWindow.postMessage(opts, '*');
|
|
260
|
+
done = true;
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
window.addEventListener('message', function(event) {
|
|
264
|
+
if (event.data === 'navReady') postMessage();
|
|
265
|
+
return false;
|
|
266
|
+
}, false);
|
|
267
|
+
}
|
|
268
|
+
|
|
269
|
+
function mainFocus() {
|
|
270
|
+
var hash = window.location.hash;
|
|
271
|
+
if (hash !== '' && $(hash)[0]) {
|
|
272
|
+
$(hash)[0].scrollIntoView();
|
|
273
|
+
}
|
|
274
|
+
|
|
275
|
+
setTimeout(function() { $('#main').focus(); }, 10);
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
function navigationChange() {
|
|
279
|
+
// This works around the broken anchor navigation with the YARD template.
|
|
280
|
+
window.onpopstate = function() {
|
|
281
|
+
var hash = window.location.hash;
|
|
282
|
+
if (hash !== '' && $(hash)[0]) {
|
|
283
|
+
$(hash)[0].scrollIntoView();
|
|
284
|
+
}
|
|
285
|
+
};
|
|
286
|
+
}
|
|
287
|
+
|
|
288
|
+
$(document).ready(function() {
|
|
289
|
+
navResizer();
|
|
290
|
+
navExpander();
|
|
291
|
+
createSourceLinks();
|
|
292
|
+
createDefineLinks();
|
|
293
|
+
createFullTreeLinks();
|
|
294
|
+
searchFrameButtons();
|
|
295
|
+
linkSummaries();
|
|
296
|
+
summaryToggle();
|
|
297
|
+
constantSummaryToggle();
|
|
298
|
+
generateTOC();
|
|
299
|
+
mainFocus();
|
|
300
|
+
navigationChange();
|
|
301
|
+
});
|
|
302
|
+
|
|
303
|
+
})();
|