|author||Lee Rhodes <email@example.com>||Thu May 21 14:53:35 2020 -0700|
|committer||GitHub <firstname.lastname@example.org>||Thu May 21 14:53:35 2020 -0700|
Merge pull request #120 from apache/Readme Update Readme
The goal of this component of the library is to provide high performance access to native memory for primitives and primitive arrays. It also provides consistent views into heap-based primitive arrays, Java ByteBuffers and memory mapped files. This package is general purpose, has minimal external runtime dependencies and can be used in any application that needs to manage data structures outside the Java heap.
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 DataSketches component is pure Java and you must compile using JDK 8.
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:
$ 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.
Disclaimer: Apache DataSketches is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.