← Back to branch summary

~ubuntu-branches/ubuntu/trusty/hyperestraier/trusty-proposed

« back to all changes in this revision

Viewing changes to doc/rubypureapi/classes/EstraierPure/Condition.html

  • Committer: Bazaar Package Importer
  • Author(s): Steve Langasek
  • Date: 2006-11-14 05:28:32 UTC
  • mfrom: (2.1.4 feisty)
  • Revision ID: james.westby@ubuntu.com-20061114052832-0lzqzcefn8mt4yqe
Tags: 1.4.9-1.1
* Non-maintainer upload.
* High-urgency upload for RC bugfix.
* Set HOME=$(CURDIR)/junkhome when building, otherwise the package build
  will incorrectly look for headers there -- and fail when the directory
  exists and is unreadable, as happens sometimes on sudo-using
  autobuilders!

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/rubypureapi/classes/EstraierPure/Condition.html
92
92
      <h3 class="section-bar">Methods</h3>
93
93
 
94
94
      <div class="name-list">
95
 
      <a href="#M000038">add_attr</a>&nbsp;&nbsp;
96
 
      <a href="#M000043">attrs</a>&nbsp;&nbsp;
97
 
      <a href="#M000045">max</a>&nbsp;&nbsp;
98
 
      <a href="#M000047">new</a>&nbsp;&nbsp;
99
 
      <a href="#M000046">options</a>&nbsp;&nbsp;
100
 
      <a href="#M000044">order</a>&nbsp;&nbsp;
101
 
      <a href="#M000042">phrase</a>&nbsp;&nbsp;
102
 
      <a href="#M000040">set_max</a>&nbsp;&nbsp;
103
 
      <a href="#M000041">set_options</a>&nbsp;&nbsp;
104
 
      <a href="#M000039">set_order</a>&nbsp;&nbsp;
105
 
      <a href="#M000037">set_phrase</a>&nbsp;&nbsp;
 
95
      <a href="#M000044">add_attr</a>&nbsp;&nbsp;
 
96
      <a href="#M000053">attrs</a>&nbsp;&nbsp;
 
97
      <a href="#M000058">auxiliary</a>&nbsp;&nbsp;
 
98
      <a href="#M000059">distinct</a>&nbsp;&nbsp;
 
99
      <a href="#M000060">mask</a>&nbsp;&nbsp;
 
100
      <a href="#M000055">max</a>&nbsp;&nbsp;
 
101
      <a href="#M000061">new</a>&nbsp;&nbsp;
 
102
      <a href="#M000057">options</a>&nbsp;&nbsp;
 
103
      <a href="#M000054">order</a>&nbsp;&nbsp;
 
104
      <a href="#M000052">phrase</a>&nbsp;&nbsp;
 
105
      <a href="#M000049">set_auxiliary</a>&nbsp;&nbsp;
 
106
      <a href="#M000050">set_distinct</a>&nbsp;&nbsp;
 
107
      <a href="#M000051">set_mask</a>&nbsp;&nbsp;
 
108
      <a href="#M000046">set_max</a>&nbsp;&nbsp;
 
109
      <a href="#M000048">set_options</a>&nbsp;&nbsp;
 
110
      <a href="#M000045">set_order</a>&nbsp;&nbsp;
 
111
      <a href="#M000043">set_phrase</a>&nbsp;&nbsp;
 
112
      <a href="#M000047">set_skip</a>&nbsp;&nbsp;
 
113
      <a href="#M000056">skip</a>&nbsp;&nbsp;
106
114
      </div>
107
115
    </div>
108
116
 
125
133
          <td class="context-item-value">1 &lt;&lt; 0</td>
126
134
          <td width="3em">&nbsp;</td>
127
135
          <td class="context-item-desc">
128
 
option: check N-gram keys skipping by three
 
136
option: check every N-gram key
129
137
 
130
138
</td>
131
139
        </tr>
135
143
          <td class="context-item-value">1 &lt;&lt; 1</td>
136
144
          <td width="3em">&nbsp;</td>
137
145
          <td class="context-item-desc">
138
 
option: check N-gram keys skipping by two
 
146
option: check N-gram keys skipping by one
139
147
 
140
148
</td>
141
149
        </tr>
145
153
          <td class="context-item-value">1 &lt;&lt; 2</td>
146
154
          <td width="3em">&nbsp;</td>
147
155
          <td class="context-item-desc">
148
 
option: without TF-IDF tuning
 
156
option: check N-gram keys skipping by two
149
157
 
150
158
</td>
151
159
        </tr>
155
163
          <td class="context-item-value">1 &lt;&lt; 3</td>
156
164
          <td width="3em">&nbsp;</td>
157
165
          <td class="context-item-desc">
158
 
option: with the simplified phrase
 
166
option: check N-gram keys skipping by three
159
167
 
160
168
</td>
161
169
        </tr>
165
173
          <td class="context-item-value">1 &lt;&lt; 4</td>
166
174
          <td width="3em">&nbsp;</td>
167
175
          <td class="context-item-desc">
168
 
option: check every N-gram key
 
176
option: without TF-IDF tuning
169
177
 
170
178
</td>
171
179
        </tr>
175
183
          <td class="context-item-value">1 &lt;&lt; 10</td>
176
184
          <td width="3em">&nbsp;</td>
177
185
          <td class="context-item-desc">
178
 
option: check N-gram keys skipping by one
179
 
 
180
 
</td>
181
 
        </tr>
182
 
        <tr class="top-aligned-row context-row">
183
 
          <td class="context-item-name">ETCH</td>
184
 
          <td>=</td>
185
 
          <td class="context-item-value">1 &lt;&lt; 20</td>
186
 
          <td width="3em">&nbsp;</td>
187
 
          <td class="context-item-desc">
188
 
option: attach keywords
 
186
option: with the simplified phrase
 
187
 
 
188
</td>
 
189
        </tr>
 
190
        <tr class="top-aligned-row context-row">
 
191
          <td class="context-item-name">ROUGH</td>
 
192
          <td>=</td>
 
193
          <td class="context-item-value">1 &lt;&lt; 11</td>
 
194
          <td width="3em">&nbsp;</td>
 
195
          <td class="context-item-desc">
 
196
option: with the rough phrase
 
197
 
 
198
</td>
 
199
        </tr>
 
200
        <tr class="top-aligned-row context-row">
 
201
          <td class="context-item-name">UNION</td>
 
202
          <td>=</td>
 
203
          <td class="context-item-value">1 &lt;&lt; 15</td>
 
204
          <td width="3em">&nbsp;</td>
 
205
          <td class="context-item-desc">
 
206
option: with the union phrase
 
207
 
 
208
</td>
 
209
        </tr>
 
210
        <tr class="top-aligned-row context-row">
 
211
          <td class="context-item-name">ISECT</td>
 
212
          <td>=</td>
 
213
          <td class="context-item-value">1 &lt;&lt; 16</td>
 
214
          <td width="3em">&nbsp;</td>
 
215
          <td class="context-item-desc">
 
216
option: with the intersection phrase
189
217
 
190
218
</td>
191
219
        </tr>
202
230
    <div id="methods">
203
231
      <h3 class="section-bar">Public Class methods</h3>
204
232
 
205
 
      <div id="method-M000047" class="method-detail">
206
 
        <a name="M000047"></a>
 
233
      <div id="method-M000061" class="method-detail">
 
234
        <a name="M000061"></a>
207
235
 
208
236
        <div class="method-heading">
209
 
          <a href="Condition.src/M000047.html" target="Code" class="method-signature"
210
 
            onclick="popupCode('Condition.src/M000047.html');return false;">
 
237
          <a href="Condition.src/M000061.html" target="Code" class="method-signature"
 
238
            onclick="popupCode('Condition.src/M000061.html');return false;">
211
239
          <span class="method-name">new</span><span class="method-args">()</span>
212
240
          </a>
213
241
        </div>
221
249
 
222
250
      <h3 class="section-bar">Public Instance methods</h3>
223
251
 
224
 
      <div id="method-M000038" class="method-detail">
225
 
        <a name="M000038"></a>
 
252
      <div id="method-M000044" class="method-detail">
 
253
        <a name="M000044"></a>
226
254
 
227
255
        <div class="method-heading">
228
 
          <a href="Condition.src/M000038.html" target="Code" class="method-signature"
229
 
            onclick="popupCode('Condition.src/M000038.html');return false;">
 
256
          <a href="Condition.src/M000044.html" target="Code" class="method-signature"
 
257
            onclick="popupCode('Condition.src/M000044.html');return false;">
230
258
          <span class="method-name">add_attr</span><span class="method-args">(expr)</span>
231
259
          </a>
232
260
        </div>
239
267
        </div>
240
268
      </div>
241
269
 
242
 
      <div id="method-M000043" class="method-detail">
243
 
        <a name="M000043"></a>
 
270
      <div id="method-M000053" class="method-detail">
 
271
        <a name="M000053"></a>
244
272
 
245
273
        <div class="method-heading">
246
 
          <a href="Condition.src/M000043.html" target="Code" class="method-signature"
247
 
            onclick="popupCode('Condition.src/M000043.html');return false;">
 
274
          <a href="Condition.src/M000053.html" target="Code" class="method-signature"
 
275
            onclick="popupCode('Condition.src/M000053.html');return false;">
248
276
          <span class="method-name">attrs</span><span class="method-args">()</span>
249
277
          </a>
250
278
        </div>
257
285
        </div>
258
286
      </div>
259
287
 
260
 
      <div id="method-M000045" class="method-detail">
261
 
        <a name="M000045"></a>
262
 
 
263
 
        <div class="method-heading">
264
 
          <a href="Condition.src/M000045.html" target="Code" class="method-signature"
265
 
            onclick="popupCode('Condition.src/M000045.html');return false;">
 
288
      <div id="method-M000058" class="method-detail">
 
289
        <a name="M000058"></a>
 
290
 
 
291
        <div class="method-heading">
 
292
          <a href="Condition.src/M000058.html" target="Code" class="method-signature"
 
293
            onclick="popupCode('Condition.src/M000058.html');return false;">
 
294
          <span class="method-name">auxiliary</span><span class="method-args">()</span>
 
295
          </a>
 
296
        </div>
 
297
      
 
298
        <div class="method-description">
 
299
          <p>
 
300
Get permission to adopt result of the auxiliary index. The return value is
 
301
permission to adopt result of the auxiliary index.
 
302
</p>
 
303
        </div>
 
304
      </div>
 
305
 
 
306
      <div id="method-M000059" class="method-detail">
 
307
        <a name="M000059"></a>
 
308
 
 
309
        <div class="method-heading">
 
310
          <a href="Condition.src/M000059.html" target="Code" class="method-signature"
 
311
            onclick="popupCode('Condition.src/M000059.html');return false;">
 
312
          <span class="method-name">distinct</span><span class="method-args">()</span>
 
313
          </a>
 
314
        </div>
 
315
      
 
316
        <div class="method-description">
 
317
          <p>
 
318
Get the attribute distinction filter. The return value is the name of the
 
319
distinct attribute.
 
320
</p>
 
321
        </div>
 
322
      </div>
 
323
 
 
324
      <div id="method-M000060" class="method-detail">
 
325
        <a name="M000060"></a>
 
326
 
 
327
        <div class="method-heading">
 
328
          <a href="Condition.src/M000060.html" target="Code" class="method-signature"
 
329
            onclick="popupCode('Condition.src/M000060.html');return false;">
 
330
          <span class="method-name">mask</span><span class="method-args">()</span>
 
331
          </a>
 
332
        </div>
 
333
      
 
334
        <div class="method-description">
 
335
          <p>
 
336
Get the mask of targets of meta search. The return value is the mask of
 
337
targets of meta search.
 
338
</p>
 
339
        </div>
 
340
      </div>
 
341
 
 
342
      <div id="method-M000055" class="method-detail">
 
343
        <a name="M000055"></a>
 
344
 
 
345
        <div class="method-heading">
 
346
          <a href="Condition.src/M000055.html" target="Code" class="method-signature"
 
347
            onclick="popupCode('Condition.src/M000055.html');return false;">
266
348
          <span class="method-name">max</span><span class="method-args">()</span>
267
349
          </a>
268
350
        </div>
275
357
        </div>
276
358
      </div>
277
359
 
278
 
      <div id="method-M000046" class="method-detail">
279
 
        <a name="M000046"></a>
 
360
      <div id="method-M000057" class="method-detail">
 
361
        <a name="M000057"></a>
280
362
 
281
363
        <div class="method-heading">
282
 
          <a href="Condition.src/M000046.html" target="Code" class="method-signature"
283
 
            onclick="popupCode('Condition.src/M000046.html');return false;">
 
364
          <a href="Condition.src/M000057.html" target="Code" class="method-signature"
 
365
            onclick="popupCode('Condition.src/M000057.html');return false;">
284
366
          <span class="method-name">options</span><span class="method-args">()</span>
285
367
          </a>
286
368
        </div>
292
374
        </div>
293
375
      </div>
294
376
 
295
 
      <div id="method-M000044" class="method-detail">
296
 
        <a name="M000044"></a>
 
377
      <div id="method-M000054" class="method-detail">
 
378
        <a name="M000054"></a>
297
379
 
298
380
        <div class="method-heading">
299
 
          <a href="Condition.src/M000044.html" target="Code" class="method-signature"
300
 
            onclick="popupCode('Condition.src/M000044.html');return false;">
 
381
          <a href="Condition.src/M000054.html" target="Code" class="method-signature"
 
382
            onclick="popupCode('Condition.src/M000054.html');return false;">
301
383
          <span class="method-name">order</span><span class="method-args">()</span>
302
384
          </a>
303
385
        </div>
309
391
        </div>
310
392
      </div>
311
393
 
312
 
      <div id="method-M000042" class="method-detail">
313
 
        <a name="M000042"></a>
 
394
      <div id="method-M000052" class="method-detail">
 
395
        <a name="M000052"></a>
314
396
 
315
397
        <div class="method-heading">
316
 
          <a href="Condition.src/M000042.html" target="Code" class="method-signature"
317
 
            onclick="popupCode('Condition.src/M000042.html');return false;">
 
398
          <a href="Condition.src/M000052.html" target="Code" class="method-signature"
 
399
            onclick="popupCode('Condition.src/M000052.html');return false;">
318
400
          <span class="method-name">phrase</span><span class="method-args">()</span>
319
401
          </a>
320
402
        </div>
326
408
        </div>
327
409
      </div>
328
410
 
329
 
      <div id="method-M000040" class="method-detail">
330
 
        <a name="M000040"></a>
331
 
 
332
 
        <div class="method-heading">
333
 
          <a href="Condition.src/M000040.html" target="Code" class="method-signature"
334
 
            onclick="popupCode('Condition.src/M000040.html');return false;">
 
411
      <div id="method-M000049" class="method-detail">
 
412
        <a name="M000049"></a>
 
413
 
 
414
        <div class="method-heading">
 
415
          <a href="Condition.src/M000049.html" target="Code" class="method-signature"
 
416
            onclick="popupCode('Condition.src/M000049.html');return false;">
 
417
          <span class="method-name">set_auxiliary</span><span class="method-args">(min)</span>
 
418
          </a>
 
419
        </div>
 
420
      
 
421
        <div class="method-description">
 
422
          <p>
 
423
Set permission to adopt result of the auxiliary index. `min&#8217;
 
424
specifies the minimum hits to adopt result of the auxiliary index. If it is
 
425
not more than 0, the auxiliary index is not used. By default, it is 32. The
 
426
return value is always `nil&#8217;.
 
427
</p>
 
428
        </div>
 
429
      </div>
 
430
 
 
431
      <div id="method-M000050" class="method-detail">
 
432
        <a name="M000050"></a>
 
433
 
 
434
        <div class="method-heading">
 
435
          <a href="Condition.src/M000050.html" target="Code" class="method-signature"
 
436
            onclick="popupCode('Condition.src/M000050.html');return false;">
 
437
          <span class="method-name">set_distinct</span><span class="method-args">(name)</span>
 
438
          </a>
 
439
        </div>
 
440
      
 
441
        <div class="method-description">
 
442
          <p>
 
443
Set the attribute distinction filter. `name&#8217; specifies the name of an
 
444
attribute to be distinct. The return value is always `nil&#8217;.
 
445
</p>
 
446
        </div>
 
447
      </div>
 
448
 
 
449
      <div id="method-M000051" class="method-detail">
 
450
        <a name="M000051"></a>
 
451
 
 
452
        <div class="method-heading">
 
453
          <a href="Condition.src/M000051.html" target="Code" class="method-signature"
 
454
            onclick="popupCode('Condition.src/M000051.html');return false;">
 
455
          <span class="method-name">set_mask</span><span class="method-args">(mask)</span>
 
456
          </a>
 
457
        </div>
 
458
      
 
459
        <div class="method-description">
 
460
          <p>
 
461
Set the mask of targets of meta search. `mask&#8217; specifies a masking
 
462
number. 1 means the first target, 2 means the second target, 4 means the
 
463
third target, and power values of 2 and their summation compose the mask.
 
464
The return value is always `nil&#8217;.
 
465
</p>
 
466
        </div>
 
467
      </div>
 
468
 
 
469
      <div id="method-M000046" class="method-detail">
 
470
        <a name="M000046"></a>
 
471
 
 
472
        <div class="method-heading">
 
473
          <a href="Condition.src/M000046.html" target="Code" class="method-signature"
 
474
            onclick="popupCode('Condition.src/M000046.html');return false;">
335
475
          <span class="method-name">set_max</span><span class="method-args">(max)</span>
336
476
          </a>
337
477
        </div>
345
485
        </div>
346
486
      </div>
347
487
 
348
 
      <div id="method-M000041" class="method-detail">
349
 
        <a name="M000041"></a>
 
488
      <div id="method-M000048" class="method-detail">
 
489
        <a name="M000048"></a>
350
490
 
351
491
        <div class="method-heading">
352
 
          <a href="Condition.src/M000041.html" target="Code" class="method-signature"
353
 
            onclick="popupCode('Condition.src/M000041.html');return false;">
 
492
          <a href="Condition.src/M000048.html" target="Code" class="method-signature"
 
493
            onclick="popupCode('Condition.src/M000048.html');return false;">
354
494
          <span class="method-name">set_options</span><span class="method-args">(options)</span>
355
495
          </a>
356
496
        </div>
363
503
N-gram keys with skipping one key, `Condition::FAST&#8217; skips two keys,
364
504
`Condition::AGITO&#8217; skips three keys, `Condition::NOIDF&#8217;
365
505
specifies not to perform TF-IDF tuning, `Condition::SIMPLE&#8217; specifies
366
 
to use simplified phrase. `Condition::ETCH&#8217; specifies to attach the
367
 
keyword vector. Each option can be specified at the same time by bitwise
368
 
or. If keys are skipped, though search speed is improved, the relevance
369
 
ratio grows less. The return value is always `nil&#8217;.
 
506
to use simplified phrase, `Condition::ROUGH&#8217; specifies to use rough
 
507
phrase, `Condition.UNION&#8217; specifies to use union phrase,
 
508
`Condition.ISECT&#8217; specifies to use intersection phrase. Each option
 
509
can be specified at the same time by bitwise or. If keys are skipped,
 
510
though search speed is improved, the relevance ratio grows less. The return
 
511
value is always `nil&#8217;.
370
512
</p>
371
513
        </div>
372
514
      </div>
373
515
 
374
 
      <div id="method-M000039" class="method-detail">
375
 
        <a name="M000039"></a>
 
516
      <div id="method-M000045" class="method-detail">
 
517
        <a name="M000045"></a>
376
518
 
377
519
        <div class="method-heading">
378
 
          <a href="Condition.src/M000039.html" target="Code" class="method-signature"
379
 
            onclick="popupCode('Condition.src/M000039.html');return false;">
 
520
          <a href="Condition.src/M000045.html" target="Code" class="method-signature"
 
521
            onclick="popupCode('Condition.src/M000045.html');return false;">
380
522
          <span class="method-name">set_order</span><span class="method-args">(expr)</span>
381
523
          </a>
382
524
        </div>
390
532
        </div>
391
533
      </div>
392
534
 
393
 
      <div id="method-M000037" class="method-detail">
394
 
        <a name="M000037"></a>
 
535
      <div id="method-M000043" class="method-detail">
 
536
        <a name="M000043"></a>
395
537
 
396
538
        <div class="method-heading">
397
 
          <a href="Condition.src/M000037.html" target="Code" class="method-signature"
398
 
            onclick="popupCode('Condition.src/M000037.html');return false;">
 
539
          <a href="Condition.src/M000043.html" target="Code" class="method-signature"
 
540
            onclick="popupCode('Condition.src/M000043.html');return false;">
399
541
          <span class="method-name">set_phrase</span><span class="method-args">(phrase)</span>
400
542
          </a>
401
543
        </div>
408
550
        </div>
409
551
      </div>
410
552
 
 
553
      <div id="method-M000047" class="method-detail">
 
554
        <a name="M000047"></a>
 
555
 
 
556
        <div class="method-heading">
 
557
          <a href="Condition.src/M000047.html" target="Code" class="method-signature"
 
558
            onclick="popupCode('Condition.src/M000047.html');return false;">
 
559
          <span class="method-name">set_skip</span><span class="method-args">(skip)</span>
 
560
          </a>
 
561
        </div>
 
562
      
 
563
        <div class="method-description">
 
564
          <p>
 
565
Set the number of skipped documents. `skip&#8217; specifies the number of
 
566
documents to be skipped in the search result. The return value is always
 
567
`nil&#8217;.
 
568
</p>
 
569
        </div>
 
570
      </div>
 
571
 
 
572
      <div id="method-M000056" class="method-detail">
 
573
        <a name="M000056"></a>
 
574
 
 
575
        <div class="method-heading">
 
576
          <a href="Condition.src/M000056.html" target="Code" class="method-signature"
 
577
            onclick="popupCode('Condition.src/M000056.html');return false;">
 
578
          <span class="method-name">skip</span><span class="method-args">()</span>
 
579
          </a>
 
580
        </div>
 
581
      
 
582
        <div class="method-description">
 
583
          <p>
 
584
Get the number of skipped documents. The return value is the number of
 
585
documents to be skipped in the search result.
 
586
</p>
 
587
        </div>
 
588
      </div>
 
589
 
411
590
 
412
591
    </div>
413
592