summaryrefslogtreecommitdiffstats
path: root/include/util/bf_config.h
blob: 836e452c9092b677ab5a4530e4187b21ab2efcd7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
/*
 * include/util/bf_config.h
 *
 * Copyright (C) 2023-2024 Douglas B. Rumbaugh <drumbaugh@psu.edu>
 *                         Dong Xie <dongx@psu.edu>
 *
 * Distributed under the Modified BSD License.
 *
 * Global parameters for configuring bloom filters used as auxiliary
 * structures on shards within the framework. The bloom filter class
 * can be found in
 *
 * $PROJECT_ROOT/external/psudb-common/cpp/include/psu-ds/BloomFilter.h
 *
 */
#pragma once

#include <cstdlib>

namespace de {

/* global variable for specifying bloom filter FPR */
static double BF_FPR = .01;

/* global variable for specifying number of BF hash functions (k) */
static size_t BF_HASH_FUNCS = 7;

/*
 * Adjust the value of BF_FPR. The argument must be on the interval
 * (0, 1), or the behavior of bloom filters is undefined.
 */
[[maybe_unused]] static void BF_SET_FPR(double fpr) { BF_FPR = fpr; }

/*
 * Adjust the value of BF_HASH_FUNCS. The argument must be on the interval
 * (0, INT64_MAX], or the behavior of bloom filters is undefined.
 */
[[maybe_unused]] static void BF_SET_HASHFUNC(size_t func_cnt) { BF_HASH_FUNCS = func_cnt; }

} // namespace de