1/*
2 * Copyright (c) 2019 Inria
3 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met: redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer;
10 * redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution;
13 * neither the name of the copyright holders nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 *
29 * Authors: Daniel Carvalho
30 */
31
32#ifndef __BASE_FILTERS_MULTI_BLOOM_FILTER_HH__
33#define __BASE_FILTERS_MULTI_BLOOM_FILTER_HH__
34
35#include <vector>
36
37#include "base/filters/base.hh"
38
39struct BloomFilterMultiParams;
40
41namespace BloomFilter {
42
43/**
44 * This BloomFilter has multiple sub-filters, each with its own hashing
45 * functionality. The results of the operations are the results of applying
46 * them to each sub-filter.
47 */
48class Multi : public Base
49{
50  public:
51    Multi(const BloomFilterMultiParams* p);
52    ~Multi();
53
54    void clear() override;
55    void set(Addr addr) override;
56    void unset(Addr addr) override;
57
58    void merge(const Base* other) override;
59    bool isSet(Addr addr) const override;
60    int getCount(Addr addr) const override;
61    int getTotalCount() const override;
62
63  private:
64    /** Sub-filters used by this filter. */
65    std::vector<Base*> filters;
66};
67
68} // namespace BloomFilter
69
70#endif // __BASE_FILTERS_MULTI_BLOOM_FILTER_HH__
71