datasketches 0.3.2 → 0.4.0

data/vendor/datasketches-cpp/cpc/include/u32_table_impl.hpp

@@ -151,8 +151,8 @@ void u32_table<A>::rebuild(uint8_t new_lg_size) {
   const uint32_t old_size = 1 << lg_size;
   const uint32_t new_size = 1 << new_lg_size;
   if (new_size <= num_items) throw std::logic_error("new_size <= num_items");
-  vector_u32<A> old_slots = std::move(slots);
-  slots = vector_u32<A>(new_size, UINT32_MAX, old_slots.get_allocator());
+  vector_u32 old_slots = std::move(slots);
+  slots = vector_u32(new_size, UINT32_MAX, old_slots.get_allocator());
   lg_size = new_lg_size;
   for (uint32_t i = 0; i < old_size; i++) {
     if (old_slots[i] != UINT32_MAX) {
@@ -168,10 +168,10 @@ void u32_table<A>::rebuild(uint8_t new_lg_size) {
 // and even then the subsequent sort would fix things up.
 // The result is nearly sorted, so make sure to use an efficient sort for that case
 template<typename A>
-vector_u32<A> u32_table<A>::unwrapping_get_items() const {
-  if (num_items == 0) return vector_u32<A>(slots.get_allocator());
+auto u32_table<A>::unwrapping_get_items() const -> vector_u32 {
+  if (num_items == 0) return vector_u32(slots.get_allocator());
   const uint32_t table_size = 1 << lg_size;
-  vector_u32<A> result(num_items, 0, slots.get_allocator());
+  vector_u32 result(num_items, 0, slots.get_allocator());
   size_t i = 0;
   size_t l = 0;
   size_t r = num_items - 1;

data/vendor/datasketches-cpp/cpc/test/CMakeLists.txt

@@ -20,16 +20,15 @@ add_executable(cpc_test)
 target_link_libraries(cpc_test cpc common_test_lib)
 
 set_target_properties(cpc_test PROPERTIES
-  CXX_STANDARD 11
   CXX_STANDARD_REQUIRED YES
 )
 
-#file(TO_CMAKE_PATH "${CMAKE_CURRENT_SOURCE_DIR}" CPC_TEST_BINARY_PATH)
-#string(APPEND CPC_TEST_BINARY_PATH "/")
-#target_compile_definitions(cpc_test
-#  PRIVATE
-#    TEST_BINARY_INPUT_PATH="${CPC_TEST_BINARY_PATH}"
-#)
+file(TO_CMAKE_PATH "${CMAKE_CURRENT_SOURCE_DIR}" CPC_TEST_BINARY_PATH)
+string(APPEND CPC_TEST_BINARY_PATH "/")
+target_compile_definitions(cpc_test
+  PRIVATE
+    TEST_BINARY_INPUT_PATH="${CPC_TEST_BINARY_PATH}"
+)
 
 add_test(
   NAME cpc_test
@@ -43,3 +42,17 @@ target_sources(cpc_test
     compression_test.cpp
     cpc_sketch_allocation_test.cpp
 )
+
+if (SERDE_COMPAT)
+target_sources(cpc_test
+  PRIVATE
+    cpc_sketch_deserialize_from_java_test.cpp
+)
+endif()
+
+if (GENERATE)
+target_sources(cpc_test
+  PRIVATE
+    cpc_sketch_serialize_for_java.cpp
+)
+endif()

data/vendor/datasketches-cpp/cpc/test/cpc_sketch_deserialize_from_java_test.cpp

@@ -0,0 +1,60 @@
+/*
+ * 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.
+ */
+
+#include <catch2/catch.hpp>
+#include <fstream>
+#include <cpc_sketch.hpp>
+
+namespace datasketches {
+
+// assume the binary sketches for this test have been generated by datasketches-java code
+// in the subdirectory called "java" in the root directory of this project
+static std::string testBinaryInputPath = std::string(TEST_BINARY_INPUT_PATH) + "../../java/";
+
+TEST_CASE("cpc sketch", "[serde_compat]") {
+  const unsigned n_arr[] = {0, 100, 200, 2000, 20000};
+  for (const unsigned n: n_arr) {
+    std::ifstream is;
+    is.exceptions(std::ios::failbit | std::ios::badbit);
+    is.open(testBinaryInputPath + "cpc_n" + std::to_string(n) + "_java.sk", std::ios::binary);
+    const auto sketch = cpc_sketch::deserialize(is);
+    REQUIRE(sketch.is_empty() == (n == 0));
+    REQUIRE(sketch.get_estimate() == Approx(n).margin(n * 0.02));
+  }
+}
+
+TEST_CASE("cpc sketch negative one", "[serde_compat]") {
+  std::ifstream is;
+  is.exceptions(std::ios::failbit | std::ios::badbit);
+  is.open(testBinaryInputPath + "cpc_negative_one_java.sk", std::ios::binary);
+  auto sketch = cpc_sketch::deserialize(is);
+  REQUIRE_FALSE(sketch.is_empty());
+  REQUIRE(sketch.get_estimate() == Approx(1).margin(0.01));
+  sketch.update((uint64_t) -1);
+  sketch.update((int64_t) -1);
+  sketch.update((uint32_t) -1);
+  sketch.update((int32_t) -1);
+  sketch.update((uint16_t) -1);
+  sketch.update((int16_t) -1);
+  sketch.update((uint8_t) -1);
+  sketch.update((int8_t) -1);
+  REQUIRE(sketch.get_estimate() == Approx(1).margin(0.01));
+}
+
+} /* namespace datasketches */

data/vendor/datasketches-cpp/{python/include/py_object_lt.hpp → cpc/test/cpc_sketch_serialize_for_java.cpp}

@@ -17,21 +17,22 @@
  * under the License.
  */
 
-#ifndef _PY_OBJECT_LT_HPP_
-#define _PY_OBJECT_LT_HPP_
+#include <catch2/catch.hpp>
+#include <fstream>
+#include <cpc_sketch.hpp>
 
-#include <pybind11/pybind11.h>
+namespace datasketches {
 
-/*
-  This header defines a less than operator on generic python
-  objects. The implementation calls the object's built-in __lt__()
-  method. If that method is not defined, the call may fail.
-*/
-
-struct py_object_lt {
-  bool operator()(const pybind11::object& a, const pybind11::object& b) const {
-    return a < b;
+TEST_CASE("cpc sketch generate", "[serialize_for_java]") {
+  const unsigned n_arr[] = {0, 100, 200, 2000, 20000};
+  for (const unsigned n: n_arr) {
+    cpc_sketch sketch;
+    for (unsigned i = 1; i <= n; ++i) sketch.update(i);
+    REQUIRE(sketch.is_empty() == (n == 0));
+    REQUIRE(sketch.get_estimate() == Approx(n).margin(n * 0.02));
+    std::ofstream os("cpc_n" + std::to_string(n) + "_cpp.sk", std::ios::binary);
+    sketch.serialize(os);
   }
-};
+}
 
-#endif // _PY_OBJECT_LT_HPP_
+} /* namespace datasketches */

data/vendor/datasketches-cpp/cpc/test/cpc_sketch_test.cpp

@@ -32,10 +32,10 @@ namespace datasketches {
 static const double RELATIVE_ERROR_FOR_LG_K_11 = 0.02;
 
 TEST_CASE("cpc sketch: lg k limits", "[cpc_sketch]") {
-  cpc_sketch s1(CPC_MIN_LG_K); // this should work
-  cpc_sketch s2(CPC_MAX_LG_K); // this should work
-  REQUIRE_THROWS_AS(cpc_sketch(CPC_MIN_LG_K - 1), std::invalid_argument);
-  REQUIRE_THROWS_AS(cpc_sketch(CPC_MAX_LG_K + 1), std::invalid_argument);
+  cpc_sketch s1(cpc_constants::MIN_LG_K); // this should work
+  cpc_sketch s2(cpc_constants::MAX_LG_K); // this should work
+  REQUIRE_THROWS_AS(cpc_sketch(cpc_constants::MIN_LG_K - 1), std::invalid_argument);
+  REQUIRE_THROWS_AS(cpc_sketch(cpc_constants::MAX_LG_K + 1), std::invalid_argument);
 }
 
 TEST_CASE("cpc sketch: empty", "[cpc_sketch]") {
@@ -88,9 +88,6 @@ TEST_CASE("cpc sketch: serialize deserialize empty", "[cpc_sketch]") {
   REQUIRE(deserialized.is_empty() == sketch.is_empty());
   REQUIRE(deserialized.get_estimate() == sketch.get_estimate());
   REQUIRE(deserialized.validate());
-
-  std::ofstream os("cpc-empty.bin");
-  sketch.serialize(os);
 }
 
 TEST_CASE("cpc sketch: serialize deserialize sparse", "[cpc_sketch]") {
@@ -108,9 +105,6 @@ TEST_CASE("cpc sketch: serialize deserialize sparse", "[cpc_sketch]") {
   for (int i = 0; i < n; i++) deserialized.update(i);
   REQUIRE(deserialized.get_estimate() == sketch.get_estimate());
   REQUIRE(deserialized.validate());
-
-  std::ofstream os("cpc-sparse.bin");
-  sketch.serialize(os);
 }
 
 TEST_CASE("cpc sketch: serialize deserialize hybrid", "[cpc_sketch]") {
@@ -128,9 +122,6 @@ TEST_CASE("cpc sketch: serialize deserialize hybrid", "[cpc_sketch]") {
   for (int i = 0; i < n; i++) deserialized.update(i);
   REQUIRE(deserialized.get_estimate() == sketch.get_estimate());
   REQUIRE(deserialized.validate());
-
-  std::ofstream os("cpc-hybrid.bin");
-  sketch.serialize(os);
 }
 
 TEST_CASE("cpc sketch: serialize deserialize pinned", "[cpc_sketch]") {
@@ -148,9 +139,6 @@ TEST_CASE("cpc sketch: serialize deserialize pinned", "[cpc_sketch]") {
   for (int i = 0; i < n; i++) deserialized.update(i);
   REQUIRE(deserialized.get_estimate() == sketch.get_estimate());
   REQUIRE(deserialized.validate());
-
-  std::ofstream os("cpc-pinned.bin");
-  sketch.serialize(os);
 }
 
 TEST_CASE("cpc sketch: serialize deserialize sliding", "[cpc_sketch]") {
@@ -168,9 +156,6 @@ TEST_CASE("cpc sketch: serialize deserialize sliding", "[cpc_sketch]") {
   for (int i = 0; i < n; i++) deserialized.update(i);
   REQUIRE(deserialized.get_estimate() == sketch.get_estimate());
   REQUIRE(deserialized.validate());
-
-  std::ofstream os("cpc-sliding.bin");
-  sketch.serialize(os);
 }
 
 TEST_CASE("cpc sketch: serializing deserialize sliding large", "[cpc_sketch]") {
@@ -188,9 +173,6 @@ TEST_CASE("cpc sketch: serializing deserialize sliding large", "[cpc_sketch]") {
   for (int i = 0; i < n; i++) deserialized.update(i);
   REQUIRE(deserialized.get_estimate() == sketch.get_estimate());
   REQUIRE(deserialized.validate());
-
-  std::ofstream os("cpc-sliding-large.bin");
-  sketch.serialize(os);
 }
 
 TEST_CASE("cpc sketch: serialize deserialize empty, bytes", "[cpc_sketch]") {
@@ -201,9 +183,6 @@ TEST_CASE("cpc sketch: serialize deserialize empty, bytes", "[cpc_sketch]") {
   REQUIRE(deserialized.get_estimate() == sketch.get_estimate());
   REQUIRE(deserialized.validate());
   REQUIRE_THROWS_AS(cpc_sketch::deserialize(bytes.data(), bytes.size() - 1), std::out_of_range);
-
-  std::ofstream os("cpc-empty.bin");
-  sketch.serialize(os);
 }
 
 TEST_CASE("cpc sketch: serialize deserialize sparse, bytes", "[cpc_sketch]") {
@@ -261,8 +240,6 @@ TEST_CASE("cpc sketch: serialize deserialize pinned, bytes", "[cpc_sketch]") {
   for (int i = 0; i < n; i++) deserialized.update(i);
   REQUIRE(deserialized.get_estimate() == sketch.get_estimate());
   REQUIRE(deserialized.validate());
-
-  std::cout << sketch.to_string();
 }
 
 TEST_CASE("cpc sketch: serialize deserialize sliding, bytes", "[cpc_sketch]") {
@@ -380,8 +357,6 @@ TEST_CASE("cpc sketch: update int equivalence", "[cpc_sketch]") {
   sketch.update((uint8_t) -1);
   sketch.update((int8_t) -1);
   REQUIRE(sketch.get_estimate() == Approx(1).margin(RELATIVE_ERROR_FOR_LG_K_11));
-  std::ofstream os("cpc-negative-one.bin"); // to compare with Java
-  sketch.serialize(os);
 }
 
 TEST_CASE("cpc sketch: update float equivalence", "[cpc_sketch]") {

data/vendor/datasketches-cpp/cpc/test/cpc_union_test.cpp

@@ -28,10 +28,10 @@ namespace datasketches {
 static const double RELATIVE_ERROR_FOR_LG_K_11 = 0.02;
 
 TEST_CASE("cpc union: lg k limits", "[cpc_union]") {
-  cpc_union u1(CPC_MIN_LG_K); // this should work
-  cpc_union u2(CPC_MAX_LG_K); // this should work
-  REQUIRE_THROWS_AS(cpc_union(CPC_MIN_LG_K - 1), std::invalid_argument);
-  REQUIRE_THROWS_AS(cpc_union(CPC_MAX_LG_K + 1), std::invalid_argument);
+  cpc_union u1(cpc_constants::MIN_LG_K); // this should work
+  cpc_union u2(cpc_constants::MAX_LG_K); // this should work
+  REQUIRE_THROWS_AS(cpc_union(cpc_constants::MIN_LG_K - 1), std::invalid_argument);
+  REQUIRE_THROWS_AS(cpc_union(cpc_constants::MAX_LG_K + 1), std::invalid_argument);
 }
 
 TEST_CASE("cpc union: empty", "[cpc_union]") {

data/vendor/datasketches-cpp/density/include/density_sketch.hpp

@@ -28,15 +28,6 @@
 
 #include "common_defs.hpp"
 
-/*
- * Based on the following paper:
- * Zohar Karnin, Edo Liberty "Discrepancy, Coresets, and Sketches in Machine Learning"
- * https://proceedings.mlr.press/v99/karnin19a/karnin19a.pdf
- *
- * Inspired by the following implementation:
- * https://github.com/edoliberty/streaming-quantiles/blob/f688c8161a25582457b0a09deb4630a81406293b/gde.py
- */
-
 namespace datasketches {
 
 template<typename T>
@@ -46,6 +37,18 @@ struct gaussian_kernel {
   }
 };
 
+/**
+ * Density sketch.
+ *
+ * Builds a coreset from the given set of input points. Provides density estimate at a given point.
+ *
+ * Based on the following paper:
+ * Zohar Karnin, Edo Liberty "Discrepancy, Coresets, and Sketches in Machine Learning"
+ * https://proceedings.mlr.press/v99/karnin19a/karnin19a.pdf
+ *
+ * Inspired by the following implementation:
+ * https://github.com/edoliberty/streaming-quantiles/blob/f688c8161a25582457b0a09deb4630a81406293b/gde.py
+ */
 template<
   typename T,
   typename Kernel = gaussian_kernel<T>,
@@ -118,6 +121,10 @@ public:
   template<typename FwdSketch>
   void merge(FwdSketch&& other);
 
+  /**
+   * Density estimate at a given point
+   * @return density estimate at a given point
+   */
   T get_estimate(const std::vector<T>& point) const;
 
   /**
@@ -172,7 +179,20 @@ public:
   string<Allocator> to_string(bool print_levels = false, bool print_items = false) const;
 
   class const_iterator;
+
+  /**
+   * Iterator pointing to the first item in the sketch.
+   * If the sketch is empty, the returned iterator must not be dereferenced or incremented.
+   * @return iterator pointing to the first item in the sketch
+   */
   const_iterator begin() const;
+
+  /**
+   * Iterator pointing to the past-the-end item in the sketch.
+   * The past-the-end item is the hypothetical item that would follow the last item.
+   * It does not point to any item, and must not be dereferenced or incremented.
+   * @return iterator pointing to the past-the-end item in the sketch
+   */
   const_iterator end() const;
 
 private:

data/vendor/datasketches-cpp/density/include/density_sketch_impl.hpp

@@ -143,7 +143,7 @@ template<typename T, typename K, typename A>
 void density_sketch<T, K, A>::compact_level(unsigned height) {
   auto& level = levels_[height];
   std::vector<bool> bits(level.size());
-  bits[0] = random_bit();
+  bits[0] = random_utils::random_bit();
   std::random_shuffle(level.begin(), level.end());
   for (unsigned i = 1; i < level.size(); ++i) {
     T delta = 0;

data/vendor/datasketches-cpp/density/test/CMakeLists.txt

@@ -20,7 +20,6 @@ add_executable(density_test)
 target_link_libraries(density_test density common_test_lib)
 
 set_target_properties(density_test PROPERTIES
-  CXX_STANDARD 11
   CXX_STANDARD_REQUIRED YES
 )
 

data/vendor/datasketches-cpp/fi/include/frequent_items_sketch.hpp

@@ -32,15 +32,19 @@
 
 namespace datasketches {
 
-/*
+/// Frequent items error type
+enum frequent_items_error_type {
+  NO_FALSE_POSITIVES, ///< include an item in the result list if get_lower_bound(item) &gt; threshold
+  NO_FALSE_NEGATIVES ///< include an item in the result list if get_upper_bound(item) &gt; threshold
+};
+
+/**
+ * Frequent Items sketch.
+ *
  * Based on Java implementation here:
  * https://github.com/apache/datasketches-java/blob/master/src/main/java/org/apache/datasketches/frequencies/ItemsSketch.java
- * author Alexander Saydakov
+ * @author Alexander Saydakov
  */
-
-enum frequent_items_error_type { NO_FALSE_POSITIVES, NO_FALSE_NEGATIVES };
-
-// type W for weight must be an arithmetic type (integral or floating point)
 template<
   typename T,
   typename W = uint64_t,
@@ -49,6 +53,7 @@ template<
   typename A = std::allocator<T>
 >
 class frequent_items_sketch {
+  static_assert(std::is_arithmetic<W>::value, "Arithmetic type expected");
 public:
 
   static const uint8_t LG_MIN_MAP_SIZE = 3;
@@ -194,7 +199,7 @@ public:
    * There may be items omitted from the set with true frequencies greater than the
    * threshold (false negatives).</p>
    *
-   * @param error_type determines whether no false positives or no false negatives are desired.
+   * @param err_type determines whether no false positives or no false negatives are desired.
    * @return an array of frequent items
    */
   vector_row get_frequent_items(frequent_items_error_type err_type) const;
@@ -217,7 +222,7 @@ public:
    * There may be items omitted from the set with true frequencies greater than the
    * threshold (false negatives).</p>
    *
-   * @param error_type determines whether no false positives or no false negatives are desired.
+   * @param err_type determines whether no false positives or no false negatives are desired.
    * @param threshold to include items in the result list
    * @return an array of frequent items
    */
@@ -293,7 +298,9 @@ private:
   static const uint8_t PREAMBLE_LONGS_EMPTY = 1;
   static const uint8_t PREAMBLE_LONGS_NONEMPTY = 4;
   static constexpr double EPSILON_FACTOR = 3.5;
-  enum flags { IS_EMPTY };
+  // due to a mistake different bits were used in C++ and Java to indicate empty sketch
+  // therefore both are set and checked for compatibility with historical binary format
+  enum flags { IS_EMPTY_1 = 0, IS_EMPTY_2 = 2 };
   W total_weight;
   W offset;
   reverse_purge_hash_map<T, W, H, E, A> map;
@@ -318,14 +325,19 @@ private:
   class items_deleter;
 };
 
+/// Row in the output from #get_frequent_items
 template<typename T, typename W, typename H, typename E, typename A>
 class frequent_items_sketch<T, W, H, E, A>::row {
 public:
   row(const T* item, W weight, W offset):
     item(item), weight(weight), offset(offset) {}
+  /// @return item
   const T& get_item() const { return *item; }
+  /// @return frequency (weight) estimate
   W get_estimate() const { return weight + offset; }
+  /// @return estimate lower bound
   W get_lower_bound() const { return weight; }
+  /// @return estimate upper bound
   W get_upper_bound() const { return weight + offset; }
 private:
   const T* item;

data/vendor/datasketches-cpp/fi/include/frequent_items_sketch_impl.hpp

@@ -174,7 +174,8 @@ void frequent_items_sketch<T, W, H, E, A>::serialize(std::ostream& os, const Ser
   const uint8_t lg_cur_size = map.get_lg_cur_size();
   write(os, lg_cur_size);
   const uint8_t flags_byte(
-    (is_empty() ? 1 << flags::IS_EMPTY : 0)
+      (is_empty() ? 1 << flags::IS_EMPTY_1 : 0)
+    | (is_empty() ? 1 << flags::IS_EMPTY_2 : 0)
   );
   write(os, flags_byte);
   const uint16_t unused16 = 0;
@@ -234,7 +235,8 @@ auto frequent_items_sketch<T, W, H, E, A>::serialize(unsigned header_size_bytes,
   const uint8_t lg_cur_size = map.get_lg_cur_size();
   ptr += copy_to_mem(lg_cur_size, ptr);
   const uint8_t flags_byte(
-    (is_empty() ? 1 << flags::IS_EMPTY : 0)
+      (is_empty() ? 1 << flags::IS_EMPTY_1 : 0)
+    | (is_empty() ? 1 << flags::IS_EMPTY_2 : 0)
   );
   ptr += copy_to_mem(flags_byte, ptr);
   ptr += sizeof(uint16_t); // unused
@@ -298,7 +300,7 @@ frequent_items_sketch<T, W, H, E, A> frequent_items_sketch<T, W, H, E, A>::deser
   const auto flags_byte = read<uint8_t>(is);
   read<uint16_t>(is); // unused
 
-  const bool is_empty = flags_byte & (1 << flags::IS_EMPTY);
+  const bool is_empty = (flags_byte & (1 << flags::IS_EMPTY_1)) | (flags_byte & (1 << flags::IS_EMPTY_2));
 
   check_preamble_longs(preamble_longs, is_empty);
   check_serial_version(serial_version);
@@ -352,7 +354,7 @@ frequent_items_sketch<T, W, H, E, A> frequent_items_sketch<T, W, H, E, A>::deser
   ptr += copy_from_mem(ptr, flags_byte);
   ptr += sizeof(uint16_t); // unused
 
-  const bool is_empty = flags_byte & (1 << flags::IS_EMPTY);
+  const bool is_empty = (flags_byte & (1 << flags::IS_EMPTY_1)) | (flags_byte & (1 << flags::IS_EMPTY_2));
 
   check_preamble_longs(preamble_longs, is_empty);
   check_serial_version(serial_version);

data/vendor/datasketches-cpp/fi/test/CMakeLists.txt

@@ -20,7 +20,6 @@ add_executable(fi_test)
 target_link_libraries(fi_test fi common_test_lib)
 
 set_target_properties(fi_test PROPERTIES
-  CXX_STANDARD 11
   CXX_STANDARD_REQUIRED YES
 )
 
@@ -42,3 +41,17 @@ target_sources(fi_test
     frequent_items_sketch_test.cpp
     frequent_items_sketch_custom_type_test.cpp
 )
+
+if (SERDE_COMPAT)
+target_sources(fi_test
+  PRIVATE
+   frequent_items_sketch_deserialize_from_java_test.cpp
+)
+endif()
+
+if (GENERATE)
+target_sources(fi_test
+  PRIVATE
+   frequent_items_sketch_serialize_for_java.cpp
+)
+endif()

data/vendor/datasketches-cpp/fi/test/frequent_items_sketch_deserialize_from_java_test.cpp

@@ -0,0 +1,95 @@
+/*
+ * 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.
+ */
+
+#include <catch2/catch.hpp>
+#include <fstream>
+#include <frequent_items_sketch.hpp>
+
+namespace datasketches {
+
+// assume the binary sketches for this test have been generated by datasketches-java code
+// in the subdirectory called "java" in the root directory of this project
+static std::string testBinaryInputPath = std::string(TEST_BINARY_INPUT_PATH) + "../../java/";
+
+TEST_CASE("frequent longs", "[serde_compat]") {
+  const unsigned n_arr[] = {0, 1, 10, 100, 1000, 10000, 100000, 1000000};
+  for (const unsigned n: n_arr) {
+    std::ifstream is;
+    is.exceptions(std::ios::failbit | std::ios::badbit);
+    is.open(testBinaryInputPath + "frequent_long_n" + std::to_string(n) + "_java.sk", std::ios::binary);
+    const auto sketch = frequent_items_sketch<int64_t>::deserialize(is);
+    REQUIRE(sketch.is_empty() == (n == 0));
+    if (n > 10) {
+      REQUIRE(sketch.get_maximum_error() > 0);
+    } else {
+      REQUIRE(sketch.get_maximum_error() == 0);
+    }
+    REQUIRE(sketch.get_total_weight() == n);
+  }
+}
+
+TEST_CASE("frequent strings", "[serde_compat]") {
+  const unsigned n_arr[] = {0, 1, 10, 100, 1000, 10000, 100000, 1000000};
+  for (const unsigned n: n_arr) {
+    std::ifstream is;
+    is.exceptions(std::ios::failbit | std::ios::badbit);
+    is.open(testBinaryInputPath + "frequent_string_n" + std::to_string(n) + "_java.sk", std::ios::binary);
+    const auto sketch = frequent_items_sketch<std::string>::deserialize(is);
+    REQUIRE(sketch.is_empty() == (n == 0));
+    if (n > 10) {
+      REQUIRE(sketch.get_maximum_error() > 0);
+    } else {
+      REQUIRE(sketch.get_maximum_error() == 0);
+    }
+    REQUIRE(sketch.get_total_weight() == n);
+  }
+}
+
+TEST_CASE("frequent strings ascii", "[serde_compat]") {
+  std::ifstream is;
+  is.exceptions(std::ios::failbit | std::ios::badbit);
+  is.open(testBinaryInputPath + "frequent_string_ascii_java.sk", std::ios::binary);
+  const auto sketch = frequent_items_sketch<std::string>::deserialize(is);
+  REQUIRE_FALSE(sketch.is_empty());
+  REQUIRE(sketch.get_maximum_error() == 0);
+  REQUIRE(sketch.get_total_weight() == 10);
+  REQUIRE(sketch.get_estimate("aaaaaaaaaaaaaaaaaaaaaaaaaaaaa") == 1);
+  REQUIRE(sketch.get_estimate("bbbbbbbbbbbbbbbbbbbbbbbbbbbbb") == 2);
+  REQUIRE(sketch.get_estimate("ccccccccccccccccccccccccccccc") == 3);
+  REQUIRE(sketch.get_estimate("ddddddddddddddddddddddddddddd") == 4);
+}
+
+TEST_CASE("frequent strings utf8", "[serde_compat]") {
+  std::ifstream is;
+  is.exceptions(std::ios::failbit | std::ios::badbit);
+  is.open(testBinaryInputPath + "frequent_string_utf8_java.sk", std::ios::binary);
+  const auto sketch = frequent_items_sketch<std::string>::deserialize(is);
+  REQUIRE_FALSE(sketch.is_empty());
+  REQUIRE(sketch.get_maximum_error() == 0);
+  REQUIRE(sketch.get_total_weight() == 28);
+  REQUIRE(sketch.get_estimate("абвгд") == 1);
+  REQUIRE(sketch.get_estimate("еёжзи") == 2);
+  REQUIRE(sketch.get_estimate("йклмн") == 3);
+  REQUIRE(sketch.get_estimate("опрст") == 4);
+  REQUIRE(sketch.get_estimate("уфхцч") == 5);
+  REQUIRE(sketch.get_estimate("шщъыь") == 6);
+  REQUIRE(sketch.get_estimate("эюя") == 7);
+}
+
+} /* namespace datasketches */