1/*
2 * Copyright (c) 2015-2017, Intel Corporation
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 *
7 * * Redistributions of source code must retain the above copyright notice,
8 * this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of Intel Corporation nor the names of its contributors
13 * may be used to endorse or promote products derived from this software
14 * without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** \file
30 * \brief Multibit: build code (for sparse iterators)
31 */
32
33#ifndef MULTIBIT_BUILD_H
34#define MULTIBIT_BUILD_H
35
36#include "hs_common.h"
37#include "multibit_internal.h"
38#include "hash.h"
39
40#include <vector>
41
42inline
43bool operator==(const mmbit_sparse_iter &a, const mmbit_sparse_iter &b) {
44 return a.mask == b.mask && a.val == b.val;
45}
46
47namespace std {
48
49template<>
50struct hash<mmbit_sparse_iter> {
51 size_t operator()(const mmbit_sparse_iter &iter) const {
52 return ue2::hash_all(iter.mask, iter.val);
53 }
54};
55
56} // namespace std
57
58namespace ue2 {
59
60/**
61 * \brief Return the size in bytes of a multibit that can store the given
62 * number of bits.
63 *
64 * This will throw a resource limit assertion if the requested mmbit is too
65 * large.
66 */
67u32 mmbit_size(u32 total_bits);
68
69/** \brief Construct a sparse iterator over the values in \a bits for a
70 * multibit of size \a total_bits. */
71std::vector<mmbit_sparse_iter>
72mmbBuildSparseIterator(const std::vector<u32> &bits, u32 total_bits);
73
74struct scatter_plan_raw;
75
76void mmbBuildInitRangePlan(u32 total_bits, u32 begin, u32 end,
77 scatter_plan_raw *out);
78void mmbBuildClearPlan(u32 total_bits, scatter_plan_raw *out);
79
80} // namespace ue2
81
82#endif // MULTIBIT_BUILD_H
83