You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datasketches.apache.org by al...@apache.org on 2022/11/01 22:13:32 UTC
[datasketches-cpp] 02/02: fixed doc
This is an automated email from the ASF dual-hosted git repository.
alsay pushed a commit to branch equal_to_instance
in repository https://gitbox.apache.org/repos/asf/datasketches-cpp.git
commit 8c6431b89bb6533295a1d7d977dada75b601e95b
Author: AlexanderSaydakov <Al...@users.noreply.github.com>
AuthorDate: Tue Nov 1 15:13:24 2022 -0700
fixed doc
---
fi/include/frequent_items_sketch.hpp | 10 +++++-----
kll/include/kll_sketch.hpp | 14 +++++++-------
quantiles/include/quantiles_sketch.hpp | 24 ++++++++++++------------
req/include/req_sketch.hpp | 12 ++++++------
4 files changed, 30 insertions(+), 30 deletions(-)
diff --git a/fi/include/frequent_items_sketch.hpp b/fi/include/frequent_items_sketch.hpp
index d0161c5..02a0854 100644
--- a/fi/include/frequent_items_sketch.hpp
+++ b/fi/include/frequent_items_sketch.hpp
@@ -226,7 +226,7 @@ public:
/**
* Computes size needed to serialize the current state of the sketch.
* This can be expensive since every item needs to be looked at.
- * @param serde instance of a SerDe
+ * @param sd instance of a SerDe
* @return size in bytes needed to serialize this sketch
*/
template<typename SerDe = serde<T>>
@@ -235,7 +235,7 @@ public:
/**
* This method serializes the sketch into a given stream in a binary form
* @param os output stream
- * @param serde instance of a SerDe
+ * @param sd instance of a SerDe
*/
template<typename SerDe = serde<T>>
void serialize(std::ostream& os, const SerDe& sd = SerDe()) const;
@@ -250,7 +250,7 @@ public:
* It is a blank space of a given size.
* This header is used in Datasketches PostgreSQL extension.
* @param header_size_bytes space to reserve in front of the sketch
- * @param serde instance of a SerDe
+ * @param sd instance of a SerDe
* @return serialized sketch as a vector of bytes
*/
template<typename SerDe = serde<T>>
@@ -259,7 +259,7 @@ public:
/**
* This method deserializes a sketch from a given stream.
* @param is input stream
- * @param serde instance of a SerDe
+ * @param sd instance of a SerDe
* @param equal instance of Equality operator
* @param allocator instance of an Allocator
* @return an instance of the sketch
@@ -272,7 +272,7 @@ public:
* This method deserializes a sketch from a given array of bytes.
* @param bytes pointer to the array of bytes
* @param size the size of the array
- * @param serde instance of a SerDe
+ * @param sd instance of a SerDe
* @param equal instance of Equality operator
* @param allocator instance of an Allocator
* @return an instance of the sketch
diff --git a/kll/include/kll_sketch.hpp b/kll/include/kll_sketch.hpp
index f063be6..fe0bc21 100644
--- a/kll/include/kll_sketch.hpp
+++ b/kll/include/kll_sketch.hpp
@@ -384,7 +384,7 @@ class kll_sketch {
/**
* Computes size needed to serialize the current state of the sketch.
* This version is for fixed-size arithmetic types (integral and floating point).
- * @param serde instance of a SerDe
+ * @param sd instance of a SerDe
* @return size in bytes needed to serialize this sketch
*/
template<typename TT = T, typename SerDe = serde<T>, typename std::enable_if<std::is_arithmetic<TT>::value, int>::type = 0>
@@ -393,7 +393,7 @@ class kll_sketch {
/**
* Computes size needed to serialize the current state of the sketch.
* This version is for all other types and can be expensive since every item needs to be looked at.
- * @param serde instance of a SerDe
+ * @param sd instance of a SerDe
* @return size in bytes needed to serialize this sketch
*/
template<typename TT = T, typename SerDe = serde<T>, typename std::enable_if<!std::is_arithmetic<TT>::value, int>::type = 0>
@@ -429,7 +429,7 @@ class kll_sketch {
/**
* This method serializes the sketch into a given stream in a binary form
* @param os output stream
- * @param instance of a SerDe
+ * @param sd instance of a SerDe
*/
template<typename SerDe = serde<T>>
void serialize(std::ostream& os, const SerDe& sd = SerDe()) const;
@@ -444,7 +444,7 @@ class kll_sketch {
* It is a blank space of a given size.
* This header is used in Datasketches PostgreSQL extension.
* @param header_size_bytes space to reserve in front of the sketch
- * @param instance of a SerDe
+ * @param sd instance of a SerDe
* @return serialized sketch as a vector of bytes
*/
template<typename SerDe = serde<T>>
@@ -453,7 +453,7 @@ class kll_sketch {
/**
* This method deserializes a sketch from a given stream.
* @param is input stream
- * @param serde instance of a SerDe
+ * @param sd instance of a SerDe
* @param comparator instance of a Comparator
* @param allocator instance of an Allocator
* @return an instance of a sketch
@@ -466,9 +466,9 @@ class kll_sketch {
* This method deserializes a sketch from a given array of bytes.
* @param bytes pointer to the array of bytes
* @param size the size of the array
- * @param serde instance of a SerDe
- * @param allocator instance of an Allocator
+ * @param sd instance of a SerDe
* @param comparator instance of a Comparator
+ * @param allocator instance of an Allocator
* @return an instance of a sketch
*/
template<typename SerDe = serde<T>>
diff --git a/quantiles/include/quantiles_sketch.hpp b/quantiles/include/quantiles_sketch.hpp
index 1141061..19f3519 100644
--- a/quantiles/include/quantiles_sketch.hpp
+++ b/quantiles/include/quantiles_sketch.hpp
@@ -362,28 +362,28 @@ public:
/**
* Computes size needed to serialize the current state of the sketch.
* This version is for fixed-size arithmetic types (integral and floating point).
- * @param instance of a SerDe
+ * @param sd instance of a SerDe
* @return size in bytes needed to serialize this sketch
*/
template<typename SerDe = serde<T>, typename TT = T, typename std::enable_if<std::is_arithmetic<TT>::value, int>::type = 0>
- size_t get_serialized_size_bytes(const SerDe& serde = SerDe()) const;
+ size_t get_serialized_size_bytes(const SerDe& sd = SerDe()) const;
/**
* Computes size needed to serialize the current state of the sketch.
* This version is for all other types and can be expensive since every item needs to be looked at.
- * @param instance of a SerDe
+ * @param sd instance of a SerDe
* @return size in bytes needed to serialize this sketch
*/
template<typename SerDe = serde<T>, typename TT = T, typename std::enable_if<!std::is_arithmetic<TT>::value, int>::type = 0>
- size_t get_serialized_size_bytes(const SerDe& serde = SerDe()) const;
+ size_t get_serialized_size_bytes(const SerDe& sd = SerDe()) const;
/**
* This method serializes the sketch into a given stream in a binary form
* @param os output stream
- * @param instance of a SerDe
+ * @param sd instance of a SerDe
*/
template<typename SerDe = serde<T>>
- void serialize(std::ostream& os, const SerDe& serde = SerDe()) const;
+ void serialize(std::ostream& os, const SerDe& sd = SerDe()) const;
// This is a convenience alias for users
// The type returned by the following serialize method
@@ -395,35 +395,35 @@ public:
* It is a blank space of a given size.
* This header is used in Datasketches PostgreSQL extension.
* @param header_size_bytes space to reserve in front of the sketch
- * @param instance of a SerDe
+ * @param sd instance of a SerDe
* @return serialized sketch as a vector of bytes
*/
template<typename SerDe = serde<T>>
- vector_bytes serialize(unsigned header_size_bytes = 0, const SerDe& serde = SerDe()) const;
+ vector_bytes serialize(unsigned header_size_bytes = 0, const SerDe& sd = SerDe()) const;
/**
* This method deserializes a sketch from a given stream.
* @param is input stream
- * @param serde instance of a SerDe
+ * @param sd instance of a SerDe
* @param comparator instance of a Comparator
* @param allocator instance of an Allocator
* @return an instance of a sketch
*/
template<typename SerDe = serde<T>>
- static quantiles_sketch deserialize(std::istream& is, const SerDe& serde = SerDe(),
+ static quantiles_sketch deserialize(std::istream& is, const SerDe& sd = SerDe(),
const Comparator& comparator = Comparator(), const Allocator& allocator = Allocator());
/**
* This method deserializes a sketch from a given array of bytes.
* @param bytes pointer to the array of bytes
* @param size the size of the array
- * @param serde instance of a SerDe
+ * @param sd instance of a SerDe
* @param comparator instance of a Comparator
* @param allocator instance of an Allocator
* @return an instance of a sketch
*/
template<typename SerDe = serde<T>>
- static quantiles_sketch deserialize(const void* bytes, size_t size, const SerDe& serde = SerDe(),
+ static quantiles_sketch deserialize(const void* bytes, size_t size, const SerDe& sd = SerDe(),
const Comparator& comparator = Comparator(), const Allocator& allocator = Allocator());
/**
diff --git a/req/include/req_sketch.hpp b/req/include/req_sketch.hpp
index d37f5da..0ec8286 100755
--- a/req/include/req_sketch.hpp
+++ b/req/include/req_sketch.hpp
@@ -258,7 +258,7 @@ public:
/**
* Computes size needed to serialize the current state of the sketch.
* This version is for fixed-size arithmetic types (integral and floating point).
- * @param instance of a SerDe
+ * @param sd instance of a SerDe
* @return size in bytes needed to serialize this sketch
*/
template<typename TT = T, typename SerDe = serde<T>, typename std::enable_if<std::is_arithmetic<TT>::value, int>::type = 0>
@@ -267,7 +267,7 @@ public:
/**
* Computes size needed to serialize the current state of the sketch.
* This version is for all other types and can be expensive since every item needs to be looked at.
- * @param instance of a SerDe
+ * @param sd instance of a SerDe
* @return size in bytes needed to serialize this sketch
*/
template<typename TT = T, typename SerDe = serde<T>, typename std::enable_if<!std::is_arithmetic<TT>::value, int>::type = 0>
@@ -276,7 +276,7 @@ public:
/**
* This method serializes the sketch into a given stream in a binary form
* @param os output stream
- * @param instance of a SerDe
+ * @param sd instance of a SerDe
*/
template<typename SerDe = serde<T>>
void serialize(std::ostream& os, const SerDe& sd = SerDe()) const;
@@ -291,7 +291,7 @@ public:
* It is a blank space of a given size.
* This header is used in Datasketches PostgreSQL extension.
* @param header_size_bytes space to reserve in front of the sketch
- * @param instance of a SerDe
+ * @param sd instance of a SerDe
*/
template<typename SerDe = serde<T>>
vector_bytes serialize(unsigned header_size_bytes = 0, const SerDe& sd = SerDe()) const;
@@ -299,7 +299,7 @@ public:
/**
* This method deserializes a sketch from a given stream.
* @param is input stream
- * @param serde instance of a SerDe
+ * @param sd instance of a SerDe
* @param comparator instance of a Comparator
* @param allocator instance of an Allocator
* @return an instance of a sketch
@@ -312,7 +312,7 @@ public:
* This method deserializes a sketch from a given array of bytes.
* @param bytes pointer to the array of bytes
* @param size the size of the array
- * @param serde instance of a SerDe
+ * @param sd instance of a SerDe
* @param comparator instance of a Comparator
* @param allocator instance of an Allocator
* @return an instance of a sketch
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org