documentation edits

[rrq/rrqmisc.git] / vector / tupleitem.h

diff --git a/vector/tupleitem.h b/vector/tupleitem.h
index baec9e3806d51e5d0897713d52d1f9b7169f5cb4..59589e7c90555f96dd4e521610eea0f890e48e2f 100644 (file)
--- a/vector/tupleitem.h
+++ b/vector/tupleitem.h
@@ -3,12 +3,18 @@
 
 #include <itemkeyfun.h>
 
+/**
+ * A tuple is an array of void*
+ */
+typedef void *tuple[];
+
 /**
  * A tupleschema record declares the itemkeyfun functions for tuple
  * items together with applicable arity and domain combinations. The
  * macro \ref TUPLEITEMINIT may be used to initialize particular
  * tupleschema records, which each become tupleitem declaration for
  * its particular arity and parts declarations
+ * \extends itemkeyfun
  */
 typedef struct {
     /**
@@ -17,54 +23,41 @@ typedef struct {
      * itemkeyfun pointer to be within a tupleschema record so as to
      * provide the handling of the tuple columns.
      */
-    itemkeyfun functions;
+    itemkeyfun base;
+
     /**
      * This is the number of columns in a tuple.
      */
     int arity;
+
     /**
-     * This is an array of pointers to the tuple item domains as
-     * represented by their associated itemkeyfun records.
+     * This points to an array of pointers to the tuple item domains
+     * as represented by their associated itemkeyfun records.
      */
-    itemkeyfun **schema;
+    itemkeyfun **columns;
 } tupleschema;
 
 /**
- * This callback function returns the hashcode of a key.
- *
- * \param this is a pointer to the itemkeyfun record from where this
- * callback got invoked
- *
- * \param key is the key to produce a hascode for
- *
- * \returns the hashcode which is a vector_index (i.e. unsigned long)
- *
- * The hashcode is used for indexing into the backing vector for
- * finding the an item via its key. The same key must map consistently
- * to the same hashcode while the hashtable contains an item with that
- * key. Different keys map map to the same hashcode, in which case the
- * vector placement is made at the first empty or hole slot following
- * the hashcode index.
+ * Create a tuples with given values.
  */
-extern unsigned long tupleitem_hashcode(itemkeyfun *this,void *key);
+extern tuple *tuple_create(int arity,...);
 
 /**
- * This callback function determines whether an item has a
- * given key or not.
+ * Create a tuples with given values.
  */
-extern int tupleitem_haskey(itemkeyfun *this,void *item,void *key);
+extern tupleschema *tupleschema_create(int arity,tuple *columns);
 
 /**
- * This callback function returns the key of an item by considering
- * the arity and schema.
+ * Copy the given tupleschema into a new tupleschema with some columns
+ * masked. This represents a sub-index type using the unmasked columns
+ * for indexing.
  */
-extern void *tupleitem_itemkey(itemkeyfun *this,void *item);
+extern tupleschema *tupleschema_mask(tupleschema *schema,...);
 
 /**
- * This callback function handles a key obtained from the itemkey
- * callback function to reclaim temporary allocation.
+ * \brief Return 1/0 to indicate whether the query matches the item.
  */
-extern void tupleitem_releasekey(itemkeyfun *this,void *key);
+extern int tupleschema_match(tupleschema *def,tuple *query,tuple *item);
 
 /**
  * The TUPLEITEMINIT macro is used for initializing a tupleschema
@@ -72,7 +65,7 @@ extern void tupleitem_releasekey(itemkeyfun *this,void *key);
  * of parts itemkeyfun pointers.
  */
 #define TUPLEITEMINIT(arity, ... ) {   \
-       functions = {                           \
+       .functions = {                          \
            .hashcode = tupleitem_hashcode,     \
            .haskey = tupleitem_haskey,         \
            .itemkey = tupleitem_itemkey,       \