From 0835f40ae25f97360dc393928796387d3cd6b16e Mon Sep 17 00:00:00 2001
From: Guilherme Andrade <g@gandrade.net>
Date: Wed, 19 Apr 2017 00:43:37 +0100
Subject: erts: Add enif_phash2 and enif_phash2_ranged

These allow one to hash VM terms from NIF code.
---
 erts/doc/src/erl_nif.xml | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

(limited to 'erts/doc')

diff --git a/erts/doc/src/erl_nif.xml b/erts/doc/src/erl_nif.xml
index 6bb1109415..34dae418ef 100644
--- a/erts/doc/src/erl_nif.xml
+++ b/erts/doc/src/erl_nif.xml
@@ -2369,6 +2369,36 @@ enif_map_iterator_destroy(env, &amp;iter);</code>
       </desc>
     </func>
 
+    <func>
+      <name>
+        <ret>unsigned long</ret>
+        <nametext>enif_phash2(ERL_NIF_TERM term)</nametext>
+      </name>
+      <fsummary>Portable hash function.</fsummary>
+      <desc>
+        <p>Portable hash function that gives the same hash for the same Erlang term
+          regardless of machine architecture and ERTS version. Corresponds to
+          <seealso marker="erlang#phash2-1"><c>erlang:phash2/1</c></seealso>.</p>
+        <p>Returns an unsigned integer within <c>0..2^27-1</c>.</p>
+      </desc>
+    </func>
+
+    <func>
+      <name>
+        <ret>unsigned long</ret>
+        <nametext>enif_phash2_ranged(ERL_NIF_TERM term, unsigned long range)</nametext>
+      </name>
+      <fsummary>Portable hash function.</fsummary>
+      <desc>
+        <p>Similar to <seealso marker="#enif_phash2"><c>enif_phash2</c></seealso>
+          but hash range can be specified. Corresponds to
+          <seealso marker="erlang#phash2-2"><c>erlang:phash2/2</c></seealso>.</p>
+        <p>Returns an unsigned integer within <c>0..range-1</c>
+          if <c>0 &lt; range &lt; 2^32</c>, and within <c>0..2^32-1</c> otherwise.
+        </p>
+      </desc>
+    </func>
+
     <func>
      <name><ret>int</ret><nametext>enif_port_command(ErlNifEnv* env, const
        ErlNifPort* to_port, ErlNifEnv *msg_env, ERL_NIF_TERM msg)</nametext>
-- 
cgit v1.2.3