<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html> <head profile="http://internetalchemy.org/2003/02/profile"> <link rel="foaf" type="application/rdf+xml" title="FOAF" href="http://www.openlinksw.com/dataspace/uda/about.rdf" /> <link rel="schema.dc" href="http://purl.org/dc/elements/1.1/" /> <meta name="dc.title" content="Function: dict_inc_or_put - Virtuoso Functions Guide" /> <meta name="dc.subject" content="Function: dict_inc_or_put - Virtuoso Functions Guide" /> <meta name="dc.creator" content="OpenLink Software Documentation Team ; " /> <meta name="dc.copyright" content="OpenLink Software, 1999 - 2009" /> <link rel="top" href="index.html" title="OpenLink Virtuoso Universal Server: Documentation" /> <link rel="search" href="/doc/adv_search.vspx" title="Search OpenLink Virtuoso Universal Server: Documentation" /> <link rel="parent" href="functions.html" title="Chapter Contents" /> <link rel="prev" href="appendixa.html" title="Appendix" /> <link rel="next" href="functions.html#.html" title="" /> <link rel="shortcut icon" href="../images/misc/favicon.ico" type="image/x-icon" /> <link rel="stylesheet" type="text/css" href="doc.css" /> <link rel="stylesheet" type="text/css" href="/doc/translation.css" /> <title>Function: dict_inc_or_put - Virtuoso Functions Guide</title> <meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8" /> <meta name="author" content="OpenLink Software Documentation Team ; " /> <meta name="copyright" content="OpenLink Software, 1999 - 2009" /> <meta name="keywords" content="" /> <meta name="GENERATOR" content="OpenLink XSLT Team" /> </head> <body> <div id="header"> <a name="fn_dict_inc_or_put" /> <img src="../images/misc/logo.jpg" alt="" /> <h1>22. Virtuoso Functions Guide - dict_inc_or_put</h1> </div> <div id="navbartop"> <div> <a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="fn_dict_get.html" title="dict_get">Prev</a> | <a class="link" href="fn_dict_iter_next.html" title="dict_iter_next">Next</a> </div> </div> <div id="currenttoc"> <form method="post" action="/doc/adv_search.vspx"> <div class="search">Keyword Search: <br /> <input type="text" name="q" /> <input type="submit" name="go" value="Go" /> </div> </form> <div> <a href="http://www.openlinksw.com/">www.openlinksw.com</a> </div> <div> <a href="http://docs.openlinksw.com/">docs.openlinksw.com</a> </div> <br /> <div> <a href="index.html">Book Home</a> </div> <br /> <div> <a href="contents.html">Contents</a> </div> <div> <a href="preface.html">Preface</a> </div> <br /> <div> <a class="selected" href="functions.html">Virtuoso Functions Guide</a> </div> <br /> <div> <a href="functions.html#admin">Administration</a> </div> <div> <a href="functions.html#aggr">Aggregate Functions</a> </div> <div> <a href="functions.html#array">Array Manipulation</a> </div> <div> <a href="functions.html#bpel">BPEL APIs</a> </div> <div> <a href="functions.html#backup">Backup</a> </div> <div> <a href="functions.html#compression">Compression</a> </div> <div> <a href="functions.html#cursors">Cursor</a> </div> <div> <a href="functions.html#time">Date & Time Manipulation</a> </div> <div> <a href="functions.html#debug">Debug</a> </div> <div> <a class="selected" href="functions.html#dict">Dictionary Manipulation</a> </div> <div class="selected"> <div> <a href="fn_dict_dec_or_remove.html">dict_dec_or_remove</a> </div> <div> <a href="fn_dict_duplicate.html">dict_duplicate</a> </div> <div> <a href="fn_dict_get.html">dict_get</a> </div> <div> <a class="selected" href="fn_dict_inc_or_put.html">dict_inc_or_put</a> </div> <div> <a href="fn_dict_iter_next.html">dict_iter_next</a> </div> <div> <a href="fn_dict_iter_rewind.html">dict_iter_rewind</a> </div> <div> <a href="fn_dict_list_keys.html">dict_list_keys</a> </div> <div> <a href="fn_dict_new.html">dict_new</a> </div> <div> <a href="fn_dict_put.html">dict_put</a> </div> <div> <a href="fn_dict_remove.html">dict_remove</a> </div> <div> <a href="fn_dict_size.html">dict_size</a> </div> <div> <a href="fn_dict_to_vector.html">dict_to_vector</a> </div> </div> <div> <a href="functions.html#encoding">Encoding & Decoding</a> </div> <div> <a href="functions.html#file">File Manipulation</a> </div> <div> <a href="functions.html#ft">Free Text</a> </div> <div> <a href="functions.html#hash">Hashing / Cryptographic</a> </div> <div> <a href="functions.html#ldap">LDAP</a> </div> <div> <a href="functions.html#localization">Locale</a> </div> <div> <a href="functions.html#mail">Mail</a> </div> <div> <a href="functions.html#misc">Miscellaneous</a> </div> <div> <a href="functions.html#number">Number</a> </div> <div> <a href="functions.html#phrz">Phrases</a> </div> <div> <a href="functions.html#rdf">RDF data</a> </div> <div> <a href="functions.html#rmt">Remote SQL Data Source</a> </div> <div> <a href="functions.html#repl">Replication</a> </div> <div> <a href="functions.html#soap">SOAP</a> </div> <div> <a href="functions.html#sql">SQL</a> </div> <div> <a href="functions.html#string">String</a> </div> <div> <a href="functions.html#txn">Transaction</a> </div> <div> <a href="functions.html#type">Type Mapping</a> </div> <div> <a href="functions.html#uddi">UDDI</a> </div> <div> <a href="functions.html#udt">User Defined Types & The CLR</a> </div> <div> <a href="functions.html#vad">VAD</a> </div> <div> <a href="functions.html#jvmpl">Virtuoso Java PL API</a> </div> <div> <a href="functions.html#bif">Virtuoso Server Extension Interface (VSEI)</a> </div> <div> <a href="functions.html#ws">Web & Internet</a> </div> <div> <a href="functions.html#xml">XML</a> </div> <div> <a href="functions.html#XPATH">XPATH & XQUERY</a> </div> <br /> <div> <a href="functionidx.html">Functions Index</a> </div> <br /> </div> <div id="text"> <h2>dict_inc_or_put</h2> <div class="refpurpose">Creates or increments an integer counter for a given key and a dictionary.</div> <div class="funcsynopsis"> <span class="funcdef"> <span class="function">dict_inc_or_put</span> </span> (<span class="paramdef">inout <span class="parameter">dict</span> dictionary</span>, <span class="paramdef">in <span class="parameter">key</span> any</span>, <span class="paramdef">in <span class="parameter">value_increment</span> integer</span>); </div> <div class="refsect1"> <div class="refsect1title">Description</div> <p>The function checks whether <span class="computeroutput">dict</span> contains <span class="computeroutput">key</span>. 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 <span class="computeroutput">value_decrement</span> is added to it and the result become the new value associated with <span class="computeroutput">key</span> in <span class="computeroutput">dict</span>. If key is not in the dictionary then a new item is added to the <span class="computeroutput">dict</span> in order to associate the <span class="computeroutput">key</span> with <span class="computeroutput">value_increment</span>.</p> </div> <div class="refsect1"> <div class="refsect1title">Parameters</div> <div class="refsect2"> <span class="refsect2title">dict – </span> Dictionary of counters. If the value is NULL then the function immediately returns zero. </div> <div class="refsect2"> <span class="refsect2title">key – </span> Key of a dictionary item to process. </div> <div class="refsect2"> <span class="refsect2title">value decrement – </span> A nonnegative integer (typically 1) that is added to the value associated with <span class="computeroutput">key</span> or used as a starting value of a newly created counter. </div> </div> <div class="refsect1"> <div class="refsect1title">Return Types</div> <p>The function returns zero (for NULL <span class="computeroutput">dict</span>) or the changed (or the added) value associated with the <span class="computeroutput">key</span>.</p> </div> <div class="refsect1"> <div class="refsect1title">Example</div> <a name="ex_dict_inc_or_put" /> <div class="example"> <div class="exampletitle" /> <p>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. <a href="">dict_inc_or_add</a> is to add a member, <a href="fn_dict_dec_or_remove.html">dict_dec_or_remove</a> is to remove. The following example gets an array of multisets and return the sum of them. </p> <div> <pre class="screen"> 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; }; </pre> </div> </div> </div> <div class="refsect1"> <div class="refsect1title">See Also</div> <p> <a href="fn_dict_new.html">dict_new</a> </p> <p> <a href="">dict_zap</a> </p> <p> <a href="fn_dict_put.html">dict_put</a> </p> <p> <a href="fn_dict_get.html">dict_get</a> </p> <p> <a href="fn_dict_remove.html">dict_remove</a> </p> <p> <a href="fn_dict_dec_or_remove.html">dict_dec_or_remove</a> </p> <p> <a href="fn_dict_size.html">dict_size</a> </p> <p> <a href="fn_dict_duplicate.html">dict_duplicate</a> </p> <p> <a href="fn_dict_to_vector.html">dict_to_vector</a> </p> <p> <a href="fn_dict_list_keys.html">dict_list_keys</a> </p> <p> <a href="">dict_destructive_list_rnd_keys</a> </p> <p> <a href="fn_dict_iter_rewind.html">dict_iter_rewind</a> </p> <p> <a href="fn_dict_iter_next.html">dict_iter_next</a> </p> </div> </div> <div id="footer"> <div>Copyright© 1999 - 2009 OpenLink Software All rights reserved.</div> <div id="validation"> <a href="http://validator.w3.org/check/referer"> <img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /> </a> <a href="http://jigsaw.w3.org/css-validator/"> <img src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!" height="31" width="88" /> </a> </div> </div> </body> </html>