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
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="fn_vt_is_noise">
<refmeta>
<refentrytitle>vt_is_noise</refentrytitle>
<refmiscinfo>ft</refmiscinfo>
</refmeta>
<refnamediv>
<refname>vt_is_noise</refname>
<refpurpose>determines whether input is a noise word</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_vt_is_noise">
<funcprototype id="fproto_vt_is_noise">
<funcdef><function>vt_is_noise</function></funcdef>
<paramdef>in <parameter>word</parameter> varchar</paramdef>
<paramdef>in <parameter>encoding</parameter> varchar</paramdef>
<paramdef>in <parameter>language</parameter> varchar</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_vt_is_noise"><title>Description</title>
<para>Determines whether input is a noise word.</para>
</refsect1>
<refsect1 id="params_vt_is_noise"><title>Parameters</title>
<refsect2><title>word</title>
<para>Narrow string of the word to be checked</para>
</refsect2>
<refsect2><title>encoding</title>
<para>valid encoding string</para>
</refsect2>
<refsect2><title>language</title>
<para>valid language string</para>
</refsect2>
</refsect1>
<refsect1 id="ret_vt_is_noise"><title>Return Values</title>
<para>1 or 0. This function will return 1 if the encoded word in the specified language is
considered a noise word, or 0 if not.</para>
</refsect1>
<refsect1 id="examples_vt_is_noise"><title>Examples</title>
<example id="ex_vt_is_noise"><title>Determining if a word is a Noise Word</title>
<programlisting>
select vt_is_noise ('a', 'UTF-8', 'X-ANY');
</programlisting>
<para>
will return 1
</para>
<programlisting>
select vt_is_noise ('effective', 'UTF-8', 'X-ANY');
</programlisting>
<para>
will return 0
</para>
</example>
</refsect1>
</refentry>
|
