/
helper-return-words-filter.js.html
282 lines (225 loc) · 11.1 KB
/
helper-return-words-filter.js.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>wink-nlp-utils - Wink JS - helper-return-words-filter.js</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-47082559-2"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-47082559-2');
</script>
<script src="https://use.typekit.net/cwc1qce.js"></script>
<script>
((window.gitter = {}).chat = {}).options = {
room: 'winkjs/Lobby'
};
</script>
<script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script>
<script>try{Typekit.load({ async: true });}catch(e){}</script>
<style media="screen">
body {
font-family: 'ff-tisa-sans-web-pro', serif;
}
.navbar {
border-top: 4px solid #6C307D;
box-sizing: border-box;
height: 64px;
background-color: #222;
position: fixed;
top: 0;
right: 0;
left: 0;
z-index: 1030;
display: flex;
justify-content: space-between;
}
.navbar-header {
font-weight: bold;
font-size: 30px;
}
.navbar-header a img {
height: 24px;
}
.navbar a {
color: #fff;
line-height: 60px;
margin-left: 20px;
}
.navbar-right {
margin: 0;
line-height: 50px;
list-style: none;
}
.navbar-right li {
float: left;
margin-right: 20px;
text-transform: uppercase;
letter-spacing: 1px;
padding-left: 20px;
font-size: 14px;
}
/* Override docdash */
nav {
top: 80px;
}
#main {
margin-top: 30px;
}
/* Gitter */
.gitter-open-chat-button {
background: #6C307D;
}
.gitter-open-chat-button:hover {
opacity: 0.8;
background: #6C307D;
}
.gitter-chat-embed {
top: 64px;
}
</style>
<script type="text/javascript">
window.addEventListener('DOMContentLoaded', function () {
if ( window.location.hash ) {
openMember();
window.setTimeout( function () {
window.scrollTo( 0, (window.pageYOffset || document.documentElement.scrollTop) - 72);
}, 0)
}
});
window.addEventListener( 'hashchange', function (e) {
e.stopPropagation();
openMember();
} );
function openMember() {
var id = window.location.hash.substr(1),
toggler = document.getElementById( id ),
offset = toggler.getBoundingClientRect().top,
y = window.scrollY + offset - 62 - 10;
window.scrollTo(0, y);
}
</script>
<header>
<div class="navbar">
<div class="navbar-header">
<a href="https://winkjs.org/" title="wink" class="navbar-brand">
<img src="https://winkjs.org/images/logo.svg">
wink
</a>
</div>
<ul class="nav navbar-nav navbar-right collapse navbar-collapse" id="main-nav">
<li><a href="https://winkjs.org/packages.html" class="">Packages</a></li>
<li><a href="https://winkjs.org/blog.html" class="">Blog</a></li>
<li><a href="http://github.com/winkjs">Github</a></li>
<li><a href="https://twitter.com/winkjs_org">Twitter</a></li>
<li><a href="https://winkjs.org/about.html" class="">About</a></li>
</ul>
</div>
</header>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav >
<h2><a href="index.html">Summary</a></h2><h2><a href="https://github.com/winkjs/wink-nlp-utils" target="_blank" >Github</a></h2><h3>Classes</h3><ul><li><a href="Indexer.html">Indexer</a><ul class='methods'><li data-type='method'><a href="Indexer.html#build">build</a></li><li data-type='method'><a href="Indexer.html#result">result</a></li></ul></li><li><a href="WordsFilter.html">WordsFilter</a><ul class='methods'><li data-type='method'><a href="WordsFilter.html#exclude">exclude</a></li><li data-type='method'><a href="WordsFilter.html#set">set</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="helper.html">helper</a><ul class='methods'><li data-type='method'><a href="helper.html#returnIndexer">returnIndexer</a></li><li data-type='method'><a href="helper.html#returnQuotedTextExtractor">returnQuotedTextExtractor</a></li><li data-type='method'><a href="helper.html#returnWordsFilter">returnWordsFilter</a></li></ul></li><li><a href="string.html">string</a><ul class='methods'><li data-type='method'><a href="string.html#amplifyNotElision">amplifyNotElision</a></li><li data-type='method'><a href="string.html#bagOfNGrams">bagOfNGrams</a></li><li data-type='method'><a href="string.html#composeCorpus">composeCorpus</a></li><li data-type='method'><a href="string.html#edgeNGrams">edgeNGrams</a></li><li data-type='method'><a href="string.html#extractPersonsName">extractPersonsName</a></li><li data-type='method'><a href="string.html#extractRunOfCapitalWords">extractRunOfCapitalWords</a></li><li data-type='method'><a href="string.html#lowerCase">lowerCase</a></li><li data-type='method'><a href="string.html#marker">marker</a></li><li data-type='method'><a href="string.html#ngram">ngram</a></li><li data-type='method'><a href="string.html#phonetize">phonetize</a></li><li data-type='method'><a href="string.html#removeElisions">removeElisions</a></li><li data-type='method'><a href="string.html#removeExtraSpaces">removeExtraSpaces</a></li><li data-type='method'><a href="string.html#removeHTMLTags">removeHTMLTags</a></li><li data-type='method'><a href="string.html#removePunctuations">removePunctuations</a></li><li data-type='method'><a href="string.html#removeSplChars">removeSplChars</a></li><li data-type='method'><a href="string.html#retainAlphaNums">retainAlphaNums</a></li><li data-type='method'><a href="string.html#sentences">sentences</a></li><li data-type='method'><a href="string.html#setOfChars">setOfChars</a></li><li data-type='method'><a href="string.html#setOfNGrams">setOfNGrams</a></li><li data-type='method'><a href="string.html#soundex">soundex</a></li><li data-type='method'><a href="string.html#splitElisions">splitElisions</a></li><li data-type='method'><a href="string.html#stem">stem</a></li><li data-type='method'><a href="string.html#tokenize">tokenize</a></li><li data-type='method'><a href="string.html#tokenize0">tokenize0</a></li><li data-type='method'><a href="string.html#trim">trim</a></li><li data-type='method'><a href="string.html#upperCase">upperCase</a></li></ul></li><li><a href="tokens.html">tokens</a><ul class='methods'><li data-type='method'><a href="tokens.html#appendBigrams">appendBigrams</a></li><li data-type='method'><a href="tokens.html#bagOfWords">bagOfWords</a></li><li data-type='method'><a href="tokens.html#bigrams">bigrams</a></li><li data-type='method'><a href="tokens.html#phonetize">phonetize</a></li><li data-type='method'><a href="tokens.html#propagateNegations">propagateNegations</a></li><li data-type='method'><a href="tokens.html#removeWords">removeWords</a></li><li data-type='method'><a href="tokens.html#setOfWords">setOfWords</a></li><li data-type='method'><a href="tokens.html#soundex">soundex</a></li><li data-type='method'><a href="tokens.html#stem">stem</a></li></ul></li></ul>
</nav>
<div id="main">
<h1 class="page-title">helper-return-words-filter.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>// wink-nlp-utils
// NLP Functions for amplifying negations, managing elisions,
// creating ngrams, stems, phonetic codes to tokens and more.
//
// Copyright (C) 2017-19 GRAYPE Systems Private Limited
//
// This file is part of “wink-nlp-utils”.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
// ## string
// ### returnWordsFilter
/**
*
* Returns an object containing the following functions: (a) `set()`, which returns
* a set of mapped words given in the input array `words`. (b) `exclude()` that
* is suitable for array filtering operations.
*
* If the second argument `mappers` is provided as an array of maping functions
* then these are applied on the input array before converting into a set. A
* mapper function must accept a string as argument and return a string as the result.
* Examples of mapper functions are typically **string** functionss of **`wink-nlp-utils`**
* such as `string.lowerCase()`, `string.stem()` and
* `string.soundex()`.
*
* @alias helper#returnWordsFilter
* @param {string[]} words that can be filtered using the returned wordsFilter.
* @param {function[]} [mappers=undefined] optionally used to map each word before creating
* the wordsFilter.
* @return {wordsFilter} object containg `set()` and `exclude()` functions for `words`.
* @example
* var stopWords = [ 'This', 'That', 'Are', 'Is', 'Was', 'Will', 'a' ];
* var myFilter = returnWordsFilter( stopWords, [ string.lowerCase ] );
* [ 'this', 'is', 'a', 'cat' ].filter( myFilter.exclude );
* // -> [ 'cat' ]
*/
var returnWordsFilter = function ( words, mappers ) {
var mappedWords = words;
var givenMappers = mappers || [];
givenMappers.forEach( function ( m ) {
mappedWords = mappedWords.map( m );
} );
mappedWords = new Set( mappedWords );
var exclude = function ( t ) {
return ( !( mappedWords.has( t ) ) );
}; // exclude()
var set = function () {
return mappedWords;
}; // set()
return {
set: set,
exclude: exclude
};
}; // returnWordsFilter()
module.exports = returnWordsFilter;
</code></pre>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Jun 10 2019 10:58:19 GMT+0530 (IST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>