e5477c6c6c
It better reflects the purpose of the parameter and provides better type-safety. Signed-off-by: Vladimir Krivopalov <vladimir@scylladb.com> Message-Id: <10a4fc16dafa0fb3234969041f68f9e7bfc61312.1525899669.git.vladimir@scylladb.com>
89 lines
2.7 KiB
C++
89 lines
2.7 KiB
C++
/*
|
|
* Licensed to the Apache Software Foundation (ASF) under one
|
|
* or more contributor license agreements. See the NOTICE file
|
|
* distributed with this work for additional information
|
|
* regarding copyright ownership. The ASF licenses this file
|
|
* to you under the Apache License, Version 2.0 (the
|
|
* "License"); you may not use this file except in compliance
|
|
* with the License. You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
/*
|
|
* Copyright (C) 2015 ScyllaDB
|
|
*
|
|
* Modified by ScyllaDB
|
|
*/
|
|
|
|
/*
|
|
* This file is part of Scylla.
|
|
*
|
|
* Scylla is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Scylla is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with Scylla. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
#pragma once
|
|
|
|
#include "bytes.hh"
|
|
#include "bloom_calculations.hh"
|
|
|
|
namespace utils {
|
|
|
|
struct i_filter;
|
|
using filter_ptr = std::unique_ptr<i_filter>;
|
|
|
|
enum class filter_format {
|
|
k_l_format,
|
|
m_format,
|
|
};
|
|
|
|
class hashed_key {
|
|
private:
|
|
std::array<uint64_t, 2> _hash;
|
|
public:
|
|
hashed_key(std::array<uint64_t, 2> h) : _hash(h) {}
|
|
std::array<uint64_t, 2> hash() const { return _hash; };
|
|
};
|
|
|
|
hashed_key make_hashed_key(bytes_view key);
|
|
|
|
// FIXME: serialize() and serialized_size() not implemented. We should only be serializing to
|
|
// disk, not in the wire.
|
|
struct i_filter {
|
|
virtual ~i_filter() {}
|
|
|
|
virtual void add(const bytes_view& key) = 0;
|
|
virtual bool is_present(const bytes_view& key) = 0;
|
|
virtual bool is_present(hashed_key) = 0;
|
|
virtual void clear() = 0;
|
|
virtual void close() = 0;
|
|
|
|
virtual size_t memory_size() = 0;
|
|
|
|
/**
|
|
* @return The smallest bloom_filter that can provide the given false
|
|
* positive probability rate for the given number of elements.
|
|
*
|
|
* Asserts that the given probability can be satisfied using this
|
|
* filter.
|
|
*/
|
|
static filter_ptr get_filter(int64_t num_elements, double max_false_pos_prob, filter_format format);
|
|
};
|
|
}
|