Apache Datasketches memory

Clone this repo:
  1. 8cfe117 Merge pull request #118 from apache/UpdateReadme by Lee Rhodes · 3 months ago master
  2. e28c5ee correct sentence by Lee Rhodes · 3 months ago
  3. 69f1b34 Update Readme by Lee Rhodes · 3 months ago
  4. 11c1f03 Merge pull request #117 from apache/misc by Lee Rhodes · 4 months ago
  5. 6f59f31 Changing datasketches.github.io to datasketches.apache.org plus other by Lee Rhodes · 4 months ago

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

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

DataSketches 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.

Documentation

DataSketches Library Website

Memory Package Overview Documentation

Memory Package Performance

Memory JavaDocs

Downloading Latest Release

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

Zip File from www.apache.org/dist

Jar Files from Maven Central

GitHub

Downloading Earlier Releases

Zip File from archive.apache.org/dist

Build Instructions

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.

How to Contact Us