This is an automated email from the ASF dual-hosted git repository.
alsay pushed a commit to branch doxygen
in repository https://gitbox.apache.org/repos/asf/datasketches-cpp.git
The following commit(s) were added to refs/heads/doxygen by this push:
new d7ee478 some fixes based on the review
d7ee478 is described below
commit d7ee478c06488ca84f38205c85c00a548261ee26
Author: AlexanderSaydakov <[email protected]>
AuthorDate: Wed Jul 5 14:43:58 2023 -0700
some fixes based on the review
---
common/include/quantiles_sorted_view.hpp | 8 ++++----
common/include/serde.hpp | 4 ++--
count/include/count_min.hpp | 16 ++++++++--------
req/include/req_sketch.hpp | 4 ++--
tuple/include/tuple_sketch.hpp | 2 +-
5 files changed, 17 insertions(+), 17 deletions(-)
diff --git a/common/include/quantiles_sorted_view.hpp
b/common/include/quantiles_sorted_view.hpp
index 465f186..e6dc887 100755
--- a/common/include/quantiles_sorted_view.hpp
+++ b/common/include/quantiles_sorted_view.hpp
@@ -73,7 +73,7 @@ public:
size_t size() const;
/**
- * Returns an approximation to the normalized rank of the given item from 0
to 1, inclusive.
+ * Returns an approximation to the normalized rank of the given item.
*
* <p>If the view is empty this throws std::runtime_error.
*
@@ -82,7 +82,7 @@ public:
* Otherwise the rank equals the sum of the weights of all items that are
less than the given item
* according to the Comparator.
*
- * @return an approximate rank of the given item
+ * @return an approximate normalized rank of the given item (0 to 1
inclusive)
*/
double get_rank(const T& item, bool inclusive = true) const;
@@ -94,14 +94,14 @@ public:
/**
* Returns an item from the sketch that is the best approximation to an item
- * from the original stream with the given rank.
+ * from the original stream with the given normalized rank.
*
* <p>If the view is empty this throws std::runtime_error.
*
* @param rank of an item in the hypothetical sorted stream.
* @param inclusive if true, the given rank is considered inclusive
(includes weight of an item)
*
- * @return approximate quantile associated with the given rank
+ * @return approximate quantile associated with the given normalized rank
*/
quantile_return_type get_quantile(double rank, bool inclusive = true) const;
diff --git a/common/include/serde.hpp b/common/include/serde.hpp
index 5cc55a8..ad20fe6 100644
--- a/common/include/serde.hpp
+++ b/common/include/serde.hpp
@@ -43,10 +43,10 @@ template<typename T, typename Enable = void> struct serde {
/**
* Stream deserialization
* @param is input stream
- * @param items pointer to array of items
+ * @param items pointer to array of items (items in the array are allocated
but not initialized)
* @param num number of items
*/
- void deserialize(std::istream& is, T* items, unsigned num) const; // items
allocated but not initialized
+ void deserialize(std::istream& is, T* items, unsigned num) const;
/**
* Raw bytes serialization
diff --git a/count/include/count_min.hpp b/count/include/count_min.hpp
index 7884653..1fbba0e 100644
--- a/count/include/count_min.hpp
+++ b/count/include/count_min.hpp
@@ -42,10 +42,10 @@ public:
/**
* Creates an instance of the sketch given parameters _num_hashes,
_num_buckets and hash seed, `seed`.
- * @param num_hashes : number of hash functions in the sketch. Equivalently
the number of rows in the array
- * @param num_buckets : number of buckets that hash functions map into.
Equivalently the number of columns in the array
+ * @param num_hashes number of hash functions in the sketch. Equivalently
the number of rows in the array
+ * @param num_buckets number of buckets that hash functions map into.
Equivalently the number of columns in the array
* @param seed for hash function
- * @param allocator to use by this instance
+ * @param allocator to acquire and release memory
*
* The items inserted into the sketch can be arbitrary type, so long as they
are hashable via murmurhash.
* Only update and estimate methods are added for uint64_t and string types.
@@ -68,14 +68,14 @@ public:
uint64_t get_seed() const;
/**
- * @return epsilon : double
+ * @return epsilon
* The maximum permissible error for any frequency estimate query.
* epsilon = ceil(e / _num_buckets)
*/
double get_relative_error() const;
/**
- * @return _total_weight : typename W
+ * @return _total_weight
* The total weight currently inserted into the stream.
*/
W get_total_weight() const;
@@ -106,7 +106,7 @@ public:
/**
* Specific get_estimate function for uint64_t type
* see generic get_estimate function
- * @param item : uint64_t type.
+ * @param item uint64_t type.
* @return an estimate of the item's frequency.
*/
W get_estimate(uint64_t item) const;
@@ -114,7 +114,7 @@ public:
/**
* Specific get_estimate function for int64_t type
* see generic get_estimate function
- * @param item : int64_t type.
+ * @param item int64_t type.
* @return an estimate of the item's frequency.
*/
W get_estimate(int64_t item) const;
@@ -122,7 +122,7 @@ public:
/**
* Specific get_estimate function for std::string type
* see generic get_estimate function
- * @param item : std::string type
+ * @param item std::string type
* @return an estimate of the item's frequency.
*/
W get_estimate(const std::string& item) const;
diff --git a/req/include/req_sketch.hpp b/req/include/req_sketch.hpp
index 99b4524..40563a1 100755
--- a/req/include/req_sketch.hpp
+++ b/req/include/req_sketch.hpp
@@ -95,8 +95,8 @@ public:
* 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 to use by this sketch instance
- * @param allocator instance to use by this sketch instance
+ * @param comparator instance for use by this sketch instance
+ * @param allocator instance for use by this sketch instance
*/
explicit req_sketch(uint16_t k, bool hra = true, const Comparator&
comparator = Comparator(),
const Allocator& allocator = Allocator());
diff --git a/tuple/include/tuple_sketch.hpp b/tuple/include/tuple_sketch.hpp
index 78a6764..7e07e71 100644
--- a/tuple/include/tuple_sketch.hpp
+++ b/tuple/include/tuple_sketch.hpp
@@ -580,7 +580,7 @@ protected:
};
-// base builder
+/// Tuple base builder
template<typename Derived, typename Policy, typename Allocator>
class tuple_base_builder: public theta_base_builder<Derived, Allocator> {
public:
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
