High performance native memory access for Java.

Clone this repo:
  1. 7d0278d Fix GitHub homepage reference. by Lee Rhodes · 4 weeks ago master
  2. 8f2d1fb fix typo. by Lee Rhodes · 7 weeks ago
  3. ac8d829 Remove sudo: false from .travis.yml it is obsolete. by Lee Rhodes · 4 months ago
  4. bb7ca23 Merge pull request #120 from apache/Readme by Lee Rhodes · 6 months ago
  5. 6a64af1 Update Readme by Lee Rhodes · 6 months ago

Build Status Maven Central Language grade: Java Total alerts Coverage Status

=================

DataSketches Java Memory Component

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.


Build Instructions

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

JDK8 is required to compile

This DataSketches component is pure Java and you must compile using JDK 8.

Recommended Build Tool

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:

  • datasketches-memory-X.Y.Z-incubating.jar The compiled main class files.
  • datasketches-memory-X.Y.Z-incubating-tests.jar The compiled test class files.
  • datasketches-memory-X.Y.Z-incubating-sources.jar The main source files.
  • datasketches-memory-X.Y.Z-incubating-test-sources.jar The test source files
  • datasketches-memory-X.Y.Z-incubating-javadoc.jar The compressed Javadocs.

Dependencies

Run-time

There is one run-time dependency:

  • org.slf4j:slf4j-api

Testing

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.