apache / datasketches-vector

Sketch Library for vector-based models

DataSketches Java Vector Library (Experimental)

This code is offered "as is" and may not be to the quality of code in, for example, the core datasketches-java repository.

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-vector-X.Y.Z.jar The compiled main class files.
• datasketches-vector-X.Y.Z-tests.jar The compiled test class files.
• datasketches-vector-X.Y.Z-sources.jar The main source files.
• datasketches-vector-X.Y.Z-test-sources.jar The test source files
• datasketches-vector-X.Y.Z-javadoc.jar The compressed Javadocs.

Dependencies

Run-time

There are two run-time dependencies:

• org.ojalgo : ojalgo
• org.apache.datasketches : datasketches-memory

Testing

See the pom.xml file for test dependencies.