Added memsrch function to VVS stdlib.

[vvhitespace] / stdlib / README.md

diff --git a/stdlib/README.md b/stdlib/README.md
index ee4670b..925c82c 100644 (file)
--- a/stdlib/README.md
+++ b/stdlib/README.md
@@ -33,11 +33,17 @@ header comment for each function to learn the call and return stack.
          010xxx - math functions
           10000 ----- random                        (math.pvvs)
           10001 ----- absolute value                (math.pvvs)
          010xxx - math functions
           10000 ----- random                        (math.pvvs)
           10001 ----- absolute value                (math.pvvs)

-         011xxx - unassigned
+         011xxx - heap functions
+          11000 ----- memset                        (heap.pvvs)
+          11001 ----- memcpy                        (heap.pvvs)
+          11010 ----- memrand                       (heap.pvvs)
+          11011 ----- memcmp                        (heap.pvvs)
+          11100 ----- memsrch                       (heap.pvvs)

          100xxx - unassigned
          101xxx - unassigned
          100xxx - unassigned
          101xxx - unassigned

-         110xxx - unassigned
-         111xxx - conversion functions
+         110xxx - conversion functions
+         111xxx - debug functions
+         111000 ----- dump heap                     (debug.pvvs)

         1xxxxxx - reserved for less common entry points
         1000000 ----- print sign of number          (stdio.pvvs)
         1000001 ----- print magnitude of number     (stdio.pvvs)
         1xxxxxx - reserved for less common entry points
         1000000 ----- print sign of number          (stdio.pvvs)
         1000001 ----- print magnitude of number     (stdio.pvvs)


@@ -50,3 +56,6 @@ private label space associated with it, formed as follows:
     00001000 xxxxxxxx - for use by 1000
     00001001 xxxxxxxx - for use by 1001
     ...etc
     00001000 xxxxxxxx - for use by 1000
     00001001 xxxxxxxx - for use by 1001
     ...etc

+
+Also by convention, functions which return a pointer will use the value `0` to
+represent a `NULL` pointer.