From 0e464f7be1ae9b54d0fba748ab2dc7bd435ac118 Mon Sep 17 00:00:00 2001
From: Anthony Ramine <n.oxyde@gmail.com>
Date: Fri, 9 May 2014 16:01:49 +0200
Subject: Create new BIF ets:update_counter/4

Conflicts:
	erts/emulator/beam/bif.tab
	lib/stdlib/src/ets.erl
---
 lib/stdlib/doc/src/ets.xml | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

(limited to 'lib/stdlib/doc')

diff --git a/lib/stdlib/doc/src/ets.xml b/lib/stdlib/doc/src/ets.xml
index 902a921fbf..6b9524ef63 100644
--- a/lib/stdlib/doc/src/ets.xml
+++ b/lib/stdlib/doc/src/ets.xml
@@ -1618,14 +1618,18 @@ true</pre>
     </func>
     <func> 
       <name name="update_counter" arity="3" clause_i="1"/>
+      <name name="update_counter" arity="4" clause_i="1"/>
       <name name="update_counter" arity="3" clause_i="2"/>
+      <name name="update_counter" arity="4" clause_i="2"/>
       <name name="update_counter" arity="3" clause_i="3"/>
+      <name name="update_counter" arity="4" clause_i="3"/>
       <type variable="Tab"/>
       <type variable="Key"/>
       <type variable="UpdateOp" name_i="1"/>
       <type variable="Pos" name_i="1"/>
       <type variable="Threshold" name_i="1"/>
       <type variable="SetValue" name_i="1"/>
+      <type variable="Default"/>
       <fsummary>Update a counter object in an ETS table.</fsummary>
       <desc>
         <p>This function provides an efficient way to update one or more 
@@ -1667,12 +1671,22 @@ true</pre>
           <seealso marker="#lookup/2">lookup/2</seealso> and 
           <seealso marker="#new/2">new/2</seealso>
           for details on the difference).</p>
+        <p>If a default object <c><anno>Default</anno></c> is given, it is used
+          as the object to be updated if the key is missing from the table. The
+          value in place of the key is ignored and replaced by the proper key
+          value. The return value is as if the default object had not been used,
+          that is a single updated element or a list of them.</p>
         <p>The function will fail with reason <c>badarg</c> if:</p>
         <list type="bulleted">
           <item>the table is not of type <c>set</c> or
           <c>ordered_set</c>,</item>
-          <item>no object with the right key exists,</item>
+          <item>no object with the right key exists and no default object were
+            supplied,</item>
           <item>the object has the wrong arity,</item>
+          <item>the default object arity is smaller than
+            <c><![CDATA[<keypos>]]></c></item>
+          <item>any field from the default object being updated is not an
+            integer</item>
           <item>the element to update is not an integer,</item>
           <item>the element to update is also the key, or,</item>
           <item>any of <c><anno>Pos</anno></c>, <c><anno>Incr</anno></c>, <c><anno>Threshold</anno></c> or
-- 
cgit v1.2.3