Merge pull request #54 from lemire/dlemire/adding_actions

Adding github actions.

Author: lemire

.github/workflows/basic.yml

@@ -0,0 +1,24 @@
+name: Java CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        java: [ 11, 16 ]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK
+        uses: actions/[email protected]
+        with:
+          java-version: ${{ matrix.java }}
+          distribution: 'adopt'
+      - name: Build and test with Maven
+        run: mvn package
+      - name: Build example
+        run: javac -cp target/classes/:. example.java
+      - name: Run example
+        run: java -cp target/classes/:. example

README.md

@@ -70,7 +70,8 @@ Most others do not.
 The Java Team at Intel (R) introduced the vector implementation for FastPFOR
 based on the Java Vector API that showed significant gains over the
 non-vectorized implementation. For an example usage, see
-examples/vector/Example.java. The feature requires JDK 19+.
+examples/vector/Example.java. The feature requires JDK 19+ and is currently for 
+advanced users.
 
 Maven central repository
 ------------------------
@@ -166,21 +167,22 @@ Speed is always reported in millions of integers per second.
 For Maven users
 ---------------
 
-If you are running JDK 19+
+The current development versions assume JDK 11 or better.
 
 ```
 mvn compile
+mvn exec:java
 ```
 
-If you are running earlier versions of JDK
+You may run our examples as follows:
 
+````
+mvn package
+javac -cp target/classes/:. example.java
+java -cp target/classes/:. example
 ```
-mvn compiler:compile@default-compile
-```
-
-mvn exec:java
 
-For ant users
+For ant users (legacy, currently untested)
 -------------
 
 If you use Apache ant, please try this:

example.java

@@ -88,8 +88,7 @@ public static void basicExample() {
     /**
      * Like the basicExample, but we store the input array size manually.
      */
-    @Test
-    public void basicExampleHeadless() {
+    public static void basicExampleHeadless() {
         int[] data = new int[2342351];
         System.out.println("Compressing " + data.length + " integers in one go using the headless approach");
         // data should be sorted for best

pom.xml

@@ -64,6 +64,10 @@
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-compiler-plugin</artifactId>
         <version>3.8.0</version>
+        <configuration>
+            <source>11</source>
+            <target>11</target>
+        </configuration>
         <executions>
           <execution>
             <id>default-compile</id>
@@ -76,18 +80,19 @@
                 <exclude>me/lemire/integercompression/vector/*</exclude>
                 <exclude>module-info.java</exclude>
               </excludes>
-            </configuration> 
-          </execution>                  
-          <execution>
+            </configuration>
+          </execution>
+          <!-- The vector module will be enabled when JDK19+ is LTE, currently only for advanced users. -->
+          <!--<execution>
             <id>vector-fastpfor</id>
             <phase>compile</phase>
             <goals>
               <goal>compile</goal>
             </goals>
-            <configuration>
+             <configuration>
               <release>19</release>
-            </configuration> 
-          </execution>                  
+            </configuration>
+          </execution>       -->
         </executions>
       </plugin>
       <plugin>
@@ -127,9 +132,9 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>
-        <version>3.0.0</version>
+        <version>3.4.1</version>
         <configuration>
-            <excludePackageNames>com.kamikaze.pfordelta:me.lemire.integercompression.benchmarktools</excludePackageNames>
+            <excludePackageNames>me.lemire.integercompression.vector;com.kamikaze.pfordelta:me.lemire.integercompression.benchmarktools</excludePackageNames>
        </configuration>
         <executions>
           <execution>

src/main/java/module-info.java

@@ -2,7 +2,8 @@
 
 // SPDX-License-Identifier: Apache-2.0
 module me.lemire.integercompression {
-  requires jdk.incubator.vector;
+  // This is currently only for advanced users:
+  // requires jdk.incubator.vector;
   exports me.lemire.integercompression;
   exports me.lemire.integercompression.vector;
 }