src/set/gnunet-service-set_union_strata_estimator.h

   1 /*
   2       This file is part of GNUnet
   3       (C) 2012 Christian Grothoff (and other contributing authors)
   4
   5       GNUnet is free software; you can redistribute it and/or modify
   6       it under the terms of the GNU General Public License as published
   7       by the Free Software Foundation; either version 3, or (at your
   8       option) any later version.
   9
  10       GNUnet is distributed in the hope that it will be useful, but
  11       WITHOUT ANY WARRANTY; without even the implied warranty of
  12       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13       General Public License for more details.
  14
  15       You should have received a copy of the GNU General Public License
  16       along with GNUnet; see the file COPYING.  If not, write to the
  17       Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18       Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file set/gnunet-service-set_union_strata_estimator.h
  23  * @brief estimator of set difference
  24  * @author Florian Dold
  25  */
  26
  27 #ifndef GNUNET_CONSENSUS_STRATA_ESTIMATOR_H
  28 #define GNUNET_CONSENSUS_STRATA_ESTIMATOR_H
  29
  30 #include "platform.h"
  31 #include "gnunet_common.h"
  32 #include "gnunet_util_lib.h"
  33
  34 #ifdef __cplusplus
  35 extern "C"
  36 {
  37 #if 0                           /* keep Emacsens' auto-indent happy */
  38 }
  39 #endif
  40 #endif
  41
  42
  43 /**
  44  * A handle to a strata estimator.
  45  */
  46 struct StrataEstimator
  47 {
  48
  49   struct InvertibleBloomFilter **strata;
  50
  51   /**
  52    * Size of the IBF array in @e strata
  53    */
  54   unsigned int strata_count;
  55
  56   unsigned int ibf_size;
  57 };
  58
  59
  60 /**
  61  * Write the given strata estimator to the buffer.
  62  *
  63  * @param se strata estimator to serialize
  64  * @param buf buffer to write to, must be of appropriate size
  65  */
  66 void
  67 strata_estimator_write (const struct StrataEstimator *se,
  68                         void *buf);
  69
  70
  71 /**
  72  * Read strata from the buffer into the given strata
  73  * estimator.  The strata estimator must already be allocated.
  74  *
  75  * @param buf buffer to read from
  76  * @param se strata estimator to write to
  77  */
  78 void
  79 strata_estimator_read (const void *buf,
  80                        struct StrataEstimator *se);
  81
  82
  83 /**
  84  * Create a new strata estimator with the given parameters.
  85  *
  86  * @param strata_count number of stratas, that is, number of ibfs in the estimator
  87  * @param ibf_size size of each ibf stratum
  88  * @param ibf_hashnum hashnum parameter of each ibf
  89  * @return a freshly allocated, empty strata estimator
  90  */
  91 struct StrataEstimator *
  92 strata_estimator_create (unsigned int strata_count,
  93                          uint32_t ibf_size,
  94                          uint8_t ibf_hashnum);
  95
  96
  97 /**
  98  * Get an estimation of the symmetric difference of the elements
  99  * contained in both strata estimators.
 100  *
 101  * @param se1 first strata estimator
 102  * @param se2 second strata estimator
 103  * @return abs(|se1| - |se2|)
 104  */
 105 unsigned int
 106 strata_estimator_difference (const struct StrataEstimator *se1,
 107                              const struct StrataEstimator *se2);
 108
 109
 110 /**
 111  * Add a key to the strata estimator.
 112  *
 113  * @param se strata estimator to add the key to
 114  * @param key key to add
 115  */
 116 void
 117 strata_estimator_insert (struct StrataEstimator *se,
 118                          struct IBF_Key key);
 119
 120
 121 /**
 122  * Remove a key from the strata estimator.
 123  *
 124  * @param se strata estimator to remove the key from
 125  * @param key key to remove
 126  */
 127 void
 128 strata_estimator_remove (struct StrataEstimator *se,
 129                          struct IBF_Key key);
 130
 131
 132 /**
 133  * Destroy a strata estimator, free all of its resources.
 134  *
 135  * @param se strata estimator to destroy.
 136  */
 137 void
 138 strata_estimator_destroy (struct StrataEstimator *se);
 139
 140
 141 /**
 142  * Make a copy of a strata estimator.
 143  *
 144  * @param se the strata estimator to copy
 145  * @return the copy
 146  */
 147 struct StrataEstimator *
 148 strata_estimator_dup (struct StrataEstimator *se);
 149
 150
 151 #if 0                           /* keep Emacsens' auto-indent happy */
 152 {
 153 #endif
 154 #ifdef __cplusplus
 155 }
 156 #endif
 157
 158 #endif
 159