|author||David Cromberge <email@example.com>||Tue Sep 28 22:35:34 2021 +0100|
|committer||David Cromberge <firstname.lastname@example.org>||Tue Sep 28 22:35:34 2021 +0100|
Increment major version before release
This is the core Java component of the DataSketches library. It contains all of the sketching algorithms and can be accessed directly from user applications.
Note that we have a parallel core component for C++ and Python implementations of the same sketch algorithms, datasketches-cpp.
Please visit the main DataSketches website for more information.
If you are interested in making contributions to this site please see our Community page for how to contact us.
NOTE: This component accesses resource files for testing. As a result, the directory elements of the full absolute path of the target installation directory must qualify as Java identifiers. In other words, the directory elements must not have any space characters (or non-Java identifier characters) in any of the path elements. This is required by the Oracle Java Specification in order to ensure location-independent access to resources: See Oracle Location-Independent Access to Resources
This component depends on the datasketches-memory component, and, as a result, must be compiled with one of the above JDKs. If your application only relies on the APIs of this component no special JVM arguments are required. However, if your application also directly relies on the APIs of the datasketches-memory component, you may need additional JVM arguments. Please refer to the datasketches-memory README for details.
If your application uses Maven, you can also use the pom.xml of this component as an example of how to automatically configure the JVM arguments for compilation and testing based on the version of the JDK.
This DataSketches component is structured as a Maven project and Maven is the recommended Build Tool.
There are two types of tests: normal unit tests and tests run by the strict profile.
To run normal unit tests:
$ mvn clean test
To run the strict profile tests (only supported in Java 8):
$ mvn clean test -P strict
To install jars built from the downloaded source:
$ mvn clean install -DskipTests=true
This will create the following jars:
There is one run-time dependency:
See the pom.xml file for test dependencies.