[incubator-datasketches-cpp] 01/03: documentation

[al...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

alsay pushed a commit to branch tuple_sketch
in repository https://gitbox.apache.org/repos/asf/incubator-datasketches-cpp.git

commit 862da304111cd91fdf206202d25834e499b3e1b9
Author: AlexanderSaydakov <Al...@users.noreply.github.com>
AuthorDate: Wed Jul 22 15:52:34 2020 -0700

    documentation
---
 tuple/include/tuple_sketch.hpp | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/tuple/include/tuple_sketch.hpp b/tuple/include/tuple_sketch.hpp
index 6ae8833..9e61efb 100644
--- a/tuple/include/tuple_sketch.hpp
+++ b/tuple/include/tuple_sketch.hpp
@@ -45,6 +45,9 @@ public:
 
   virtual ~tuple_sketch() = default;
 
+  /**
+   * @return allocator
+   */
   virtual Allocator get_allocator() const = 0;
 
   /**
@@ -95,6 +98,9 @@ public:
    */
   virtual uint32_t get_num_retained() const = 0;
 
+  /**
+   * @return hash of the seed that was used to hash the input
+   */
   virtual uint16_t get_seed_hash() const = 0;
 
   /**


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org