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
|
<?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
: template.sh,v 1.6 2009/04/14 11:39:26 source Exp $
-->
<refentry id="fn_dict_inc_or_put">
<refmeta>
<refentrytitle>dict_inc_or_put</refentrytitle>
<refmiscinfo>dict</refmiscinfo>
</refmeta>
<refnamediv>
<refname>dict_inc_or_put</refname>
<refpurpose>Creates or increments an integer counter for a given key and a dictionary.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_dict_inc_or_put">
<funcprototype id="fproto_dict_inc_or_put">
<funcdef><function>dict_inc_or_put</function></funcdef>
<paramdef>inout <parameter>dict</parameter> dictionary</paramdef>
<paramdef>in <parameter>key</parameter> any</paramdef>
<paramdef>in <parameter>value_increment</parameter> integer</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_dict_inc_or_put">
<title>Description</title>
<para>The function checks whether <parameter>dict</parameter> contains <parameter>key</parameter>.
If it isn't so then the function checks the datatype of the value associated with the key.
An error 42000 is signalled in case of non-integer value or a negative integer value.
If the value is positive then <parameter>value_decrement</parameter> is added to it and the result become the new value associated with <parameter>key</parameter> in <parameter>dict</parameter>.
If key is not in the dictionary then a new item is added to the <parameter>dict</parameter> in order to associate the <parameter>key</parameter> with <parameter>value_increment</parameter>.</para>
</refsect1>
<refsect1 id="params_dict_inc_or_put">
<title>Parameters</title>
<refsect2><title>dict</title>
<para>Dictionary of counters. If the value is NULL then the function immediately returns zero.</para>
</refsect2>
<refsect2><title>key</title>
<para>Key of a dictionary item to process.</para>
</refsect2>
<refsect2><title>value decrement</title>
<para>A nonnegative integer (typically 1) that is added to the value associated with <parameter>key</parameter> or used as a starting value of a newly created counter.</para>
</refsect2>
</refsect1>
<refsect1 id="ret_dict_inc_or_put"><title>Return Types</title>
<para>The function returns zero (for NULL <parameter>dict</parameter>) or the changed (or the added) value associated with the <parameter>key</parameter>.</para>
</refsect1>
<!--
<refsect1 id="errors_dict_inc_or_put">
<title>Errors</title>
<para>This function can generate the following errors:</para>
<errorcode></errorcode>
</refsect1> -->
<refsect1 id="examples_dict_inc_or_put">
<title>Example</title>
<example id="ex_dict_inc_or_put"><title>Simple Use</title>
<para>The function is convenient to deal with multisets, i.e., sets with repeating elements.
In this case the dictionary contains distinct items as keys and counts of duplicates as associated values.
<link linkend="fn_dict_inc_or_add"><function>dict_inc_or_add</function></link> is to add a member,
<link linkend="fn_dict_dec_or_remove"><function>dict_dec_or_remove</function></link> is to remove.
The following example gets an array of multisets and return the sum of them.
</para>
<screen><![CDATA[
create function DB.DBA.SUM_MULTISETS (inout msets any) returns any
{
declare sum_of_msets any;
sum_of_msets := dict_new (17);
foreach (any mset in msets) do
{
declare iter any;
declare memb any;
declare dup_count integer;
iter := mset; --- unlike dict_duplicate() this does not make copy of mset so it's fast.
dict_iter_rewind (iter);
while (dict_iter_next (iter, memb, dup_count))
dict_inc_or_put (sum_of_msets, memb, dup_count);
}
return sum_of_msets;
};
]]>
</screen>
</example>
</refsect1>
<refsect1 id="seealso_dict_inc_or_put">
<title>See Also</title>
<para><link linkend="fn_dict_new"><function>dict_new()</function></link></para>
<para><link linkend="fn_dict_zap"><function>dict_zap()</function></link></para>
<para><link linkend="fn_dict_put"><function>dict_put()</function></link></para>
<para><link linkend="fn_dict_get"><function>dict_get()</function></link></para>
<para><link linkend="fn_dict_remove"><function>dict_remove()</function></link></para>
<para><link linkend="fn_dict_dec_or_remove"><function>dict_dec_or_remove()</function></link></para>
<para><link linkend="fn_dict_size"><function>dict_size()</function></link></para>
<para><link linkend="fn_dict_duplicate"><function>dict_duplicate()</function></link></para>
<para><link linkend="fn_dict_to_vector"><function>dict_to_vector()</function></link></para>
<para><link linkend="fn_dict_list_keys"><function>dict_list_keys()</function></link></para>
<para><link linkend="fn_dict_destructive_list_rnd_keys"><function>dict_destructive_list_rnd_keys()</function></link></para>
<para><link linkend="fn_dict_iter_rewind"><function>dict_iter_rewind()</function></link></para>
<para><link linkend="fn_dict_iter_next"><function>dict_iter_next()</function></link></para>
</refsect1>
</refentry>
|
