documentation improvements

Author: AlexanderSaydakov

kll/include/kll_sketch.hpp

@@ -167,6 +167,7 @@ class kll_sketch {
   public:
     using value_type = T;
     using comparator = C;
+    using allocator_type = A;
     using vector_u32 = std::vector<uint32_t, typename std::allocator_traits<A>::template rebind_alloc<uint32_t>>;
     using vector_double = typename quantiles_sorted_view<T, C, A>::vector_double;
 
@@ -176,11 +177,41 @@ class kll_sketch {
      */
     using quantile_return_type = typename quantiles_sorted_view<T, C, A>::quantile_return_type;
 
+    /**
+     * Constructor
+     * @param k affects the size of the sketch and its estimation error
+     * @param comparator strict weak ordering function (see C++ named requirements: Compare)
+     * @param allocator used by this sketch to allocate memory
+     */
     explicit kll_sketch(uint16_t k = kll_constants::DEFAULT_K, const C& comparator = C(), const A& allocator = A());
+
+    /**
+     * Copy constructor
+     * @param other sketch to be copied
+     */
     kll_sketch(const kll_sketch& other);
+
+    /**
+     * Move constructor
+     * @param other sketch to be moved
+     */
     kll_sketch(kll_sketch&& other) noexcept;
+
+
     ~kll_sketch();
+
+    /**
+     * Copy assignment
+     * @param other sketch to be copied
+     * @return reference to this sketch
+     */
     kll_sketch& operator=(const kll_sketch& other);
+
+    /**
+     * Move assignment
+     * @param other sketch to be moved
+     * @return reference to this sketch
+     */
     kll_sketch& operator=(kll_sketch&& other);
 
     /*

quantiles/include/quantiles_sketch.hpp

@@ -160,9 +160,9 @@ class quantiles_sketch {
 
   /**
    * Constructor
-   * @param k
-   * @param comparator
-   * @param allocator
+   * @param k affects the size of the sketch and its estimation error
+   * @param comparator strict weak ordering function (see C++ named requirements: Compare)
+   * @param allocator used to allocate memory
    */
   explicit quantiles_sketch(uint16_t k = quantiles_constants::DEFAULT_K,
       const Comparator& comparator = Comparator(), const Allocator& allocator = Allocator());

req/include/req_sketch.hpp

@@ -80,6 +80,7 @@ class req_sketch {
 public:
   using value_type = T;
   using comparator = Comparator;
+  using allocator_type = Allocator;
   using Compactor = req_compactor<T, Comparator, Allocator>;
   using AllocCompactor = typename std::allocator_traits<Allocator>::template rebind_alloc<Compactor>;
   using vector_double = typename quantiles_sorted_view<T, Comparator, Allocator>::vector_double;
@@ -96,8 +97,8 @@ class req_sketch {
    * Value of 12 roughly corresponds to 1% relative error guarantee at 95% confidence.
    * @param hra if true, the default, the high ranks are prioritized for better
    * accuracy. Otherwise the low ranks are prioritized for better accuracy.
-   * @param comparator instance for use by this sketch instance
-   * @param allocator instance for use by this sketch instance
+   * @param comparator strict weak ordering function (see C++ named requirements: Compare)
+   * @param allocator used by this sketch to allocate memory
    */
   explicit req_sketch(uint16_t k, bool hra = true, const Comparator& comparator = Comparator(),
       const Allocator& allocator = Allocator());