This is an automated email from the ASF dual-hosted git repository.
git-site-role pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/datasketches-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 51bccc4f Automatic Site Publish by Buildbot
51bccc4f is described below
commit 51bccc4fd77a84441f7c5d1b13164af967ada5c5
Author: buildbot <[email protected]>
AuthorDate: Tue Jul 9 22:20:49 2024 +0000
Automatic Site Publish by Buildbot
---
output/docs/Architecture/SketchesByComponent.html | 297 +++++++++++++---------
1 file changed, 183 insertions(+), 114 deletions(-)
diff --git a/output/docs/Architecture/SketchesByComponent.html
b/output/docs/Architecture/SketchesByComponent.html
index 7b95bb67..baf9170b 100644
--- a/output/docs/Architecture/SketchesByComponent.html
+++ b/output/docs/Architecture/SketchesByComponent.html
@@ -522,11 +522,11 @@
specific language governing permissions and limitations
under the License.
-->
-<h1 id="sketches-by-component-repository">Sketches by <a
href="https://github.com/apache?utf8=%E2%9C%93&q=datasketches";>Component
Repository</a></h1>
+<h1 id="sketches-by-component-repository">Sketches by <a
href="https://datasketches.apache.org/docs/Architecture/Components.html";>Component
Repository</a></h1>
<p>The DataSketches Library is organized into the following repository
groups:</p>
-<h2 id="java">Java</h2>
+<h2 id="java-sketches">Java Sketches</h2>
<h3 id="datasketches-java">datasketches-java</h3>
<p>This repository has the core-java sketching classes, which are leveraged by
some of the other repositories. <br />
@@ -539,96 +539,99 @@ This code is versioned and the latest release can be
obtained from
<table>
<thead>
<tr>
- <th>Sketches-core Packages.</th>
- <th>Package Description</th>
+ <th>Packages (org.apache.datasketches.*)</th>
+ <th>Description</th>
</tr>
</thead>
<tbody>
<tr>
- <td>org.apache.datasketches</td>
+ <td>common</td>
<td>Common functions and utilities</td>
</tr>
<tr>
- <td>org.apache.datasketches.cpc</td>
+ <td>cpc</td>
<td>New Unique Counting Sketch with better accuracy per size than
HLL</td>
</tr>
<tr>
- <td>org.apache.datasketches.fdt</td>
+ <td>fdt</td>
<td>Frequent Distinct Tuples Sketch.</td>
</tr>
<tr>
- <td>org.apache.datasketches.frequencies</td>
+ <td>filters</td>
+ <td>Bloomfilter, Quotientfilter, etc.</td>
+ </tr>
+ <tr>
+ <td>frequencies</td>
<td>Frequent Item Sketches, for both longs and generics</td>
</tr>
<tr>
- <td>org.apache.datasketches.hash</td>
+ <td>hash</td>
<td>The 128-bit MurmurHash3 and adaptors</td>
</tr>
<tr>
- <td>org.apache.datasketches.hll</td>
+ <td>hll</td>
<td>Unique counting HLL sketches for both heap and off-heap.</td>
</tr>
<tr>
- <td>org.apache.datasketches.hllmap</td>
+ <td>hllmap</td>
<td>The (HLL) Unique Count Map Sketch</td>
</tr>
<tr>
- <td>org.apache.datasketches.kll</td>
+ <td>kll</td>
<td>Quantiles sketch with better accuracy per size than the standard
quantiles sketch. Includes PMF, CDF functions, for floats, doubles. On-heap
& off-heap.</td>
</tr>
<tr>
- <td>org.apache.datasketches.quantiles</td>
+ <td>partitions</td>
+ <td>Special tools to enable large-scale partitioning using the quantiles
sketches.</td>
+ </tr>
+ <tr>
+ <td>quantiles</td>
<td>Standard Quantiles sketch, plus PMF and CDF functions, for doubles
and generics. On-heap & off-heap.</td>
</tr>
<tr>
- <td>org.apache.datasketches.req</td>
+ <td>quantilescommon</td>
+ <td>Common functions used by all the quantiles sketches.</td>
+ </tr>
+ <tr>
+ <td>req</td>
<td>Relative Error Quantiles (REQ) sketch, plus PMF and CDF functions
for floats, on-heap. Extremely high accuracy for very high ranks (e.g.,
99.999%ile), or very low ranks (e.g., .00001%ile.</td>
</tr>
<tr>
- <td>org.apache.datasketches.sampling</td>
+ <td>sampling</td>
<td>Weighted and uniform reservoir sampling with generics</td>
</tr>
<tr>
- <td>org.apache.datasketches.theta</td>
+ <td>theta</td>
<td>Unique counting Theta Sketches for both on-heap & off-heap</td>
</tr>
<tr>
- <td>org.apache.datasketches.tuple</td>
+ <td>thetacommon</td>
+ <td>Common functions used by all the Theta and Tuple sketches</td>
+ </tr>
+ <tr>
+ <td>tuple</td>
<td>Tuple sketches for both primitives and generics</td>
</tr>
<tr>
- <td>org.apache.datasketches.tuple.adouble</td>
+ <td>tuple.adouble</td>
<td>A Tuple sketch with a Summary of a single double</td>
</tr>
<tr>
- <td>org.apache.datasketches.tuple.aninteger</td>
+ <td>tuple.arrayofdoubles</td>
+ <td>Dedicated implementation of a Tuple sketch with an array of doubles
Summary.</td>
+ </tr>
+ <tr>
+ <td>tuple.aninteger</td>
<td>A Tuple sketch with a Summary of a single integer</td>
</tr>
<tr>
- <td>org.apache.datasketches.tuple.Strings</td>
+ <td>tuple.Strings</td>
<td>A Tuple sketch with a Summary of an array of Strings</td>
</tr>
</tbody>
</table>
-<h3 id="datasketches-memory">datasketches-memory</h3>
-<p>This code is versioned and the latest release can be obtained from
-<a
href="https://datasketches.apache.org/docs/Community/Downloads.html";>Downloads</a>.</p>
-
-<table>
- <thead>
- <tr>
- <th>Memory Packages</th>
- <th>Package Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>org.apache.datasketches.memory</td>
- <td>Low level, high-performance Memory data-structure management
primarily for off-heap.</td>
- </tr>
- </tbody>
-</table>
+<h2 id="java-platform-adaptors">Java Platform Adaptors</h2>
<h3 id="datasketches-hive">datasketches-hive</h3>
<p>This repository contains Hive UDFs and UDAFs for use within Hadoop grid
enviornments.
@@ -640,37 +643,41 @@ This code is versioned and the latest release can be
obtained from
<table>
<thead>
<tr>
- <th>Sketches-hive Packages</th>
- <th>Package Description</th>
+ <th>Packages (org.apache.datasketches.*)</th>
+ <th>Description</th>
</tr>
</thead>
<tbody>
<tr>
- <td>org.apache.datasketches.hive.cpc</td>
+ <td>common</td>
+ <td>Common functions</td>
+ </tr>
+ <tr>
+ <td>hive.cpc</td>
<td>Hive UDF and UDAFs for CPC sketches</td>
</tr>
<tr>
- <td>org.apache.datasketches.hive.frequencies</td>
+ <td>hive.frequencies</td>
<td>Hive UDF and UDAFs for Frequent Items sketches</td>
</tr>
<tr>
- <td>org.apache.datasketches.hive.hll</td>
+ <td>hive.hll</td>
<td>Hive UDF and UDAFs for HLL sketches</td>
</tr>
<tr>
- <td>org.apache.datasketches.hive.kll</td>
+ <td>hive.kll</td>
<td>Hive UDF and UDAFs for KLL sketches</td>
</tr>
<tr>
- <td>org.apache.datasketches.hive.quantiles</td>
+ <td>hive.quantiles</td>
<td>Hive UDF and UDAFs for Quantiles sketches</td>
</tr>
<tr>
- <td>org.apache.datasketches.hive.theta</td>
+ <td>hive.theta</td>
<td>Hive UDF and UDAFs for Theta sketches</td>
</tr>
<tr>
- <td>org.apache.datasketches.hive.tuple</td>
+ <td>hive.tuple</td>
<td>Hive UDF and UDAFs for Tuple sketches</td>
</tr>
</tbody>
@@ -686,138 +693,123 @@ This code is versioned and the latest release can be
obtained from
<table>
<thead>
<tr>
- <th>Sketches-pig Packages</th>
- <th>Package Description</th>
+ <th>Packages (org.apache.datasketches.*)</th>
+ <th>Description</th>
</tr>
</thead>
<tbody>
<tr>
- <td>org.apache.datasketches.pig.cpc</td>
+ <td>pig.cpc</td>
<td>Pig UDFs for CPC sketches</td>
</tr>
<tr>
- <td>org.apache.datasketches.pig.frequencies</td>
+ <td>pig.frequencies</td>
<td>Pig UDFs for Frequent Items sketches</td>
</tr>
<tr>
- <td>org.apache.datasketches.pig.hash</td>
+ <td>pig.hash</td>
<td>Pig UDFs for MurmerHash3</td>
</tr>
<tr>
- <td>org.apache.datasketches.pig.hll</td>
+ <td>pig.hll</td>
<td>Pig UDFs for HLL sketches</td>
</tr>
<tr>
- <td>org.apache.datasketches.pig.kll</td>
+ <td>pig.kll</td>
<td>Pig UDFs for KLL sketches</td>
</tr>
<tr>
- <td>org.apache.datasketches.pig.quantiles</td>
+ <td>pig.quantiles</td>
<td>Pig UDFs for Quantiles sketches</td>
</tr>
<tr>
- <td>org.apache.datasketches.pig.sampling.</td>
+ <td>pig.sampling.</td>
<td>Pig UDFs for Sampling sketches</td>
</tr>
<tr>
- <td>org.apache.datasketches.pig.theta</td>
+ <td>pig.theta</td>
<td>Pig UDFs for Theta sketches</td>
</tr>
<tr>
- <td>org.apache.datasketches.pig.tuple</td>
+ <td>pig.tuple</td>
<td>Pig UDFs for Tuple sketches</td>
</tr>
</tbody>
</table>
-<h3 id="datasketches-characterization">datasketches-characterization</h3>
-<p>This relatively new repository is for Java and C++ code that we use to
characterize the accuracy and speed performance of the sketches in
-the library and is constantly being updated. Examples of the job command
files used for various tests can be found in the src/main/resources directory.
-Some of these tests can run for hours depending on its configuration. This
component is not formally released and code must be obtained from
-the <a href="https://github.com/apache/datasketches-characterization";>GitHub
site</a>.</p>
+<h2 id="c-sketches">C++ Sketches</h2>
+
+<h3 id="datasketches-cpp">datasketches-cpp</h3>
+<p>This is the evolving C++ implementations of the same sketches that are
available in Java.
+These implementations are <em>binary compatible</em> with their counterparts
in Java.
+In other words, a sketch created and serialized in C++ can be opened and read
in Java and visa-versa.
+This code is versioned and the latest release can be obtained from
+<a
href="https://datasketches.apache.org/docs/Community/Downloads.html";>Downloads</a>.</p>
<table>
<thead>
<tr>
- <th>Characterization Packages</th>
- <th>Package Description</th>
+ <th>Directory</th>
+ <th>Description</th>
</tr>
</thead>
<tbody>
<tr>
- <td>org.apache.datasketches.characterization</td>
- <td>Common functions and utilities</td>
+ <td>common</td>
+ <td>Common functions</td>
</tr>
<tr>
- <td>org.apache.datasketches.characterization.concurrent</td>
- <td>Concurrent Theta Sketch</td>
+ <td>count</td>
+ <td>Count-Min Sketch</td>
</tr>
<tr>
- <td>org.apache.datasketches.characterization.cpc</td>
- <td>Compressed Probabilistic Counting Sketch</td>
+ <td>cpc</td>
+ <td>CPC Sketch</td>
</tr>
<tr>
- <td>org.apache.datasketches.characterization.fdt</td>
- <td>Frequent Distinct Tuples Sketch</td>
+ <td>density</td>
+ <td>Density Sketch</td>
</tr>
<tr>
- <td>org.apache.datasketches.characterization.frequencies</td>
- <td>Frequent Items Sketches</td>
+ <td>fi</td>
+ <td>Frequent Items Sketch</td>
</tr>
<tr>
- <td>org.apache.datasketches.characterization.hash</td>
- <td>Hash function performance</td>
+ <td>hll</td>
+ <td>HLL Sketch</td>
</tr>
<tr>
- <td>org.apache.datasketches.characterization.hll</td>
- <td>HyperLogLog Sketcch</td>
+ <td>kll</td>
+ <td>KLL Sketch</td>
</tr>
<tr>
- <td>org.apache.datasketches.characterization.memory</td>
- <td>Memory performance</td>
+ <td>quantiles</td>
+ <td>Classic Quantiles Sketch</td>
</tr>
<tr>
- <td>org.apache.datasketches.characterization.quantiles</td>
- <td>Quantiles performance</td>
+ <td>req</td>
+ <td>REQ Sketch</td>
</tr>
<tr>
- <td>org.apache.datasketches.characterization.theta</td>
- <td>Theta Sketch</td>
+ <td>sampling</td>
+ <td>Sampling sketches</td>
+ </tr>
+ <tr>
+ <td>tdigest</td>
+ <td>t-Digest Sketch</td>
+ </tr>
+ <tr>
+ <td>theta</td>
+ <td>Theta sketches</td>
</tr>
<tr>
- <td>org.apache.datasketches.characterization.uniquecount</td>
- <td>Base Profiles for Unique Counting Sketches</td>
+ <td>tuple</td>
+ <td>Tuple sketches</td>
</tr>
</tbody>
</table>
-<h3 id="datasketches-server">datasketches-server</h3>
-<p>This is a new repository for our experimental docker/container server that
enables easy access to the core sketches in the library via HTTP.
-This component is not formally released and code must be obtained from
-the <a href="https://github.com/apache/datasketches-server";>GitHub
site</a>.</p>
-
-<h4 id="c-characterizations">C++ Characterizations</h4>
-<ul>
- <li>CPC</li>
- <li>Frequent Items</li>
- <li>HLL</li>
- <li>KLL</li>
- <li>Theta</li>
-</ul>
-
-<h3 id="datasketches-vector">datasketches-vector</h3>
-<p>This component implements the <a
href="/docs/Community/Research.html">Frequent Directions Algorithm</a> [GLP16].
It is still experimental in that the theoretical work has not yet supplied a
suitable measure of error for production work. It can be used as is, but it
will not go through a formal Apache Release until we can find a way to provide
better error properties. It has a dependence on the Memory component.
-This component is not formally released and code must be obtained from
-the <a href="https://github.com/apache/datasketches-vector";>GitHub
site</a>.</p>
-
-<h2 id="c-and-python">C++ and Python</h2>
-
-<h3 id="datasketches-cpp">datasketches-cpp</h3>
-<p>This is the evolving C++ implementations of the same sketches that are
available in Java.
-These implementations are <em>binary compatible</em> with their counterparts
in Java.
-In other words, a sketch created and stored in C++ can be opened and read in
Java and visa-versa.
-This code is versioned and the latest release can be obtained from
-<a
href="https://datasketches.apache.org/docs/Community/Downloads.html";>Downloads</a>.</p>
+<h2 id="c-platform-adaptors">C++ Platform Adaptors</h2>
<p>This site also has our <a
href="https://github.com/apache/datasketches-cpp/tree/master/python";>Python
adaptors</a> that basically wrap the C++ implementations, making the high
performance C++ implementations available from Python.</p>
@@ -826,6 +818,83 @@ This code is versioned and the latest release can be
obtained from
them available to the PostgreSQL database users. PostgreSQL users should
download the PostgreSQL extension from <a
href="https://pgxn.org/dist/datasketches/";>pgxn.org</a>. For examples refer to
the README on the component site. This code is versioned and the latest release
can be obtained from
<a
href="https://datasketches.apache.org/docs/Community/Downloads.html";>Downloads</a>.</p>
+<table>
+ <thead>
+ <tr>
+ <th>Files (src/*)</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>aod_sketch_c_adapter.h</td>
+ <td>Tuple Array-Of-Doubles Sketch</td>
+ </tr>
+ <tr>
+ <td>cpc_sketch_c_adapter.h</td>
+ <td>CPC Sketch</td>
+ </tr>
+ <tr>
+ <td>frequent_strings_sketch_c_adapter.h</td>
+ <td>Frequent Strings Sketch</td>
+ </tr>
+ <tr>
+ <td>hll_sketch_c_adapter.h</td>
+ <td>HLL Sketch</td>
+ </tr>
+ <tr>
+ <td>kll_double_sketch_c_adapter.h</td>
+ <td>KLL Doubles Sketch</td>
+ </tr>
+ <tr>
+ <td>kll_float_sketch_c_adapter.h</td>
+ <td>KLL Floats Sketch</td>
+ </tr>
+ <tr>
+ <td>quantiles_double_sketch_c_adapter.h</td>
+ <td>Classic Doubles Quantiles Sketch</td>
+ </tr>
+ <tr>
+ <td>req_float_sketch_c_adapter.h</td>
+ <td>REQ Floats Sketch</td>
+ </tr>
+ <tr>
+ <td>theta_sketch_c_adapter.h</td>
+ <td>Theta Sketch</td>
+ </tr>
+ </tbody>
+</table>
+
+<h2 id="python-sketches">Python Sketches</h2>
+
+<h3 id="datasketches-python">datasketches-python</h3>
+<p>Files (src/*) | Description
+———————–|———————
+count_wrapper.cpp | Count-Min Sketch
+cpc_wrapper.cpp | CPC Sketch
+density_wrapper.cpp | Density Sketch
+ebpps_wrapper.cpp | EB-PPS Sampling Sketch
+fi_wrapper.cpp | Frequent Items Sketch
+hll_wrapper.cpp | HLL Sketch
+kll_wrapper.cpp | KLL Sketch
+quantiles_wrapper.cpp | Classic Quantiles Sketch
+req_wrapper.cpp | REQ Sketch
+theta_wrapper.cpp | Theta sketches
+tuple_wrapper.cpp | Tuple sketches
+vector_of_kll.cpp | KLL Vector
+vo_wrapper.cpp | VarOpt Sketch</p>
+
+<h2 id="other">Other</h2>
+
+<h3 id="datasketches-server">datasketches-server</h3>
+<p>This is a new experimental repository for our experimental docker/container
server that enables easy access to the core sketches in the library via HTTP.
+This component is not formally released and code must be obtained from
+the <a href="https://github.com/apache/datasketches-server";>GitHub
site</a>.</p>
+
+<h3 id="datasketches-vector">datasketches-vector</h3>
+<p>This experimental component implements the <a
href="/docs/Community/Research.html">Frequent Directions Algorithm</a> [GLP16].
It is still experimental in that the theoretical work has not yet supplied a
suitable measure of error for production work. It can be used as is, but it
will not go through a formal Apache Release until we can find a way to provide
better error properties. It has a dependence on the Memory component.
+This component is not formally released and code must be obtained from
+the <a href="https://github.com/apache/datasketches-vector";>GitHub
site</a>.</p>
</div> <!-- End content -->
</div> <!-- End row -->
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
