tuple/include/theta_a_not_b_experimental.hpp

/*
 * 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.
 */

#ifndef THETA_A_NOT_B_EXPERIMENTAL_HPP_
#define THETA_A_NOT_B_EXPERIMENTAL_HPP_

#include "theta_sketch_experimental.hpp"
#include "theta_set_difference_base.hpp"

namespace datasketches {

template<typename Allocator = std::allocator<uint64_t>>
class theta_a_not_b_experimental {
public:
  using Entry = uint64_t;
  using ExtractKey = trivial_extract_key;
  using CompactSketch = compact_theta_sketch_experimental<Allocator>;
  using State = theta_set_difference_base<Entry, ExtractKey, CompactSketch, Allocator>;

  explicit theta_a_not_b_experimental(uint64_t seed = DEFAULT_SEED, const Allocator& allocator = Allocator());

  /**
   * Computes the a-not-b set operation given two sketches.
   * @return the result of a-not-b
   */
  template<typename FwdSketch, typename Sketch>
  CompactSketch compute(FwdSketch&& a, const Sketch& b, bool ordered = true) const;

private:
  State state_;
};

} /* namespace datasketches */

#include "theta_a_not_b_experimental_impl.hpp"

#endif