Issue 23 internal backend code refactor

.github/workflows/build-and-test.yml

@@ -0,0 +1,17 @@
+name: Build And Test on All OSs
+on: [push, pull_request]
+jobs:
+  gradle:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        java: [1.8, 11, 17, 21]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-java@v1
+        with:
+          java-version: ${{ matrix.java }}
+      - uses: eskatos/gradle-command-action@v1
+        with:
+          arguments: check --scan

build.gradle

@@ -44,14 +44,20 @@ plugins {
     id 'info.solidsoft.pitest' version '1.5.1'
 
     // Kotlin tests:
-    id 'org.jetbrains.kotlin.jvm' version '1.3.31'
+    id 'org.jetbrains.kotlin.jvm' version '1.7.10'
 
     // Public deployment :
     id 'maven-publish'
     id 'signing'
     id('io.github.gradle-nexus.publish-plugin') version '1.1.0'
+
+    // For static analysis and null checking:
+    id "net.ltgt.errorprone" version "3.1.0"
 }
 
+// If current version >= 11 we can do static analysis:
+boolean WE_CAN_DO_STATIC_ANALYSIS = JavaVersion.current().isJava11Compatible()
+println "Static analysis enabled: $WE_CAN_DO_STATIC_ANALYSIS"
 
 
 // This gives some more freedom for comments ( special characters... ).
@@ -135,18 +141,28 @@ repositories {
 // Note: Visit the java-library gradle plugin documentation for more information about api vs implementation.
 dependencies {
 
+    if ( WE_CAN_DO_STATIC_ANALYSIS ) {
+        errorprone "com.uber.nullaway:nullaway:0.10.25"
+        compileOnly "com.google.code.findbugs:jsr305:3.0.2"
+        errorprone "com.google.errorprone:error_prone_core:2.27.0"
+    }
+    else
+        errorprone "com.google.errorprone:error_prone_core:2.9.+"
+
+    implementation group: 'com.google.errorprone', name: 'error_prone_annotations', version: '2.27.0'
+    implementation group: 'org.jspecify', name: 'jspecify', version: '1.0.0'
+
     // Core library dependencies :
     implementation 'org.jocl:jocl:2.0.5' //-> Internal dependency!
 
     // Logging :
-    implementation group: 'org.slf4j', name: 'slf4j-api', version: '2.0.7'
+    implementation group: 'org.slf4j', name: 'slf4j-api', version: '[1+, )'
 
     // Test suite : Groovy, Spock (+ sl4j, + Spock-Reports)
     //-----------------------------------------------------
     // mandatory dependencies for using Spock
-    testImplementation 'org.codehaus.groovy:groovy:3.0.13'
-    testImplementation 'org.spockframework:spock-core:2.3-groovy-3.0'
-    testImplementation 'com.athaydes:spock-reports:2.3.2-groovy-3.0'
+    testImplementation 'org.spockframework:spock-core:2.3-groovy-4.0'
+    testImplementation 'com.athaydes:spock-reports:2.5.1-groovy-4.0'
 
     //testImplementation group: 'org.apache.groovy', name: 'groovy', version: '4.0.6'
     //testImplementation 'org.spockframework:spock-core:2.3-groovy-4.0'
@@ -156,14 +172,14 @@ dependencies {
     testRuntimeOnly group: 'org.objenesis', name: 'objenesis', version: '3.2'      // allows mocking of classes without default constructor (together with ByteBuddy or CGLIB)
 
     // Kotlin tests:
-    testImplementation 'org.jetbrains.kotlin:kotlin-script-runtime:1.3.31' // first the runtime so that the tests compile
+    testImplementation 'org.jetbrains.kotlin:kotlin-script-runtime:1.7.10' // first the runtime so that the tests compile
     testImplementation 'org.jetbrains.kotlin:kotlin-test' // Then some test dependencies to do assertions...
     testImplementation 'org.assertj:assertj-core:3.23.1' // Same story here!
-    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.9.0'
-    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.9.0'
+    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.10.2'
+    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.10.2'
 
-    testImplementation 'org.slf4j:slf4j-api:2.0.3'  // LOGGING
-    testImplementation 'org.slf4j:slf4j-simple:2.0.3'
+    testImplementation 'org.slf4j:slf4j-api:2.0.12' // Logging in tests
+    testImplementation 'org.slf4j:slf4j-simple:2.0.12'
 }
 
 compileTestKotlin {
@@ -180,6 +196,9 @@ test {
     // Spock-Reports configuration can be found in the test resources: src/test/resources/SpockConfig.Groovy
 
     useJUnitPlatform() // ...otherwise spock tests will not be received by gradle...
+    testLogging {
+        exceptionFormat = 'full' // So we see spock power assert messages!
+    }
 
     // Memory :
     minHeapSize = "1g"
@@ -189,13 +208,32 @@ test {
     maxParallelForks = 1//Math.floor(1+(Runtime.runtime.availableProcessors().intdiv(2) ?: 1)/2)
 }
 
+if ( WE_CAN_DO_STATIC_ANALYSIS ) {
+    tasks.withType(JavaCompile) {
+        // remove the if condition if you want to run NullAway on test code
+        if (!name.toLowerCase().contains("test")) {
+            options.errorprone {
+                check("NullAway", net.ltgt.gradle.errorprone.CheckSeverity.ERROR)
+                option("NullAway:AnnotatedPackages", "")
+                // We disable the NonCanonicalType because non-canonical type declarations are used for convenience
+                check("NonCanonicalType", net.ltgt.gradle.errorprone.CheckSeverity.OFF)
+            }
+        } else {
+            options.errorprone {
+                check("NullAway", net.ltgt.gradle.errorprone.CheckSeverity.WARN)
+                option("NullAway:AnnotatedPackages", "")
+            }
+        }
+    }
+}
+
 
 //----------------------------------------------------------------------------------------------------------------------
 // 8. CONFIGURING TEST REPORTING :
 
 jacoco {
-    toolVersion = "0.8.9"
-    reportsDir = file("docs/coverage")
+    toolVersion = "0.8.11"
+    reportsDirectory.set(file("docs/coverage"))
 }
 
 jacocoTestReport {

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.10-bin.zip
+networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradlew

@@ -55,7 +55,7 @@
 #       Darwin, MinGW, and NonStop.
 #
 #   (3) This script is generated from the Groovy template
-#       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 #       within the Gradle project.
 #
 #       You can find Gradle at https://github.com/gradle/gradle/.
@@ -80,10 +80,10 @@ do
     esac
 done
 
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-
-APP_NAME="Gradle"
+# This is normally unused
+# shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
+APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
 
 # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
 DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
@@ -143,12 +143,16 @@ fi
 if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
+        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045 
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
     case $MAX_FD in  #(
       '' | soft) :;; #(
       *)
+        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045 
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac
@@ -205,6 +209,12 @@ set -- \
         org.gradle.wrapper.GradleWrapperMain \
         "$@"
 
+# Stop when "xargs" is not available.
+if ! command -v xargs >/dev/null 2>&1
+then
+    die "xargs is not available"
+fi
+
 # Use "xargs" to parse quoted args.
 #
 # With -n1 it outputs one arg per line, with the quotes and backslashes removed.

gradlew.bat

@@ -14,7 +14,7 @@
 @rem limitations under the License.
 @rem
 
-@if "%DEBUG%" == "" @echo off
+@if "%DEBUG%"=="" @echo off
 @rem ##########################################################################
 @rem
 @rem  Gradle startup script for Windows
@@ -25,7 +25,8 @@
 if "%OS%"=="Windows_NT" setlocal
 
 set DIRNAME=%~dp0
-if "%DIRNAME%" == "" set DIRNAME=.
+if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
@@ -40,7 +41,7 @@ if defined JAVA_HOME goto findJavaFromJavaHome
 
 set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto execute
+if %ERRORLEVEL% equ 0 goto execute
 
 echo.
 echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
@@ -75,13 +76,15 @@ set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
 
 :end
 @rem End local scope for the variables with windows NT shell
-if "%ERRORLEVEL%"=="0" goto mainEnd
+if %ERRORLEVEL% equ 0 goto mainEnd
 
 :fail
 rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
 rem the _cmd.exe /c_ return code!
-if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
-exit /b 1
+set EXIT_CODE=%ERRORLEVEL%
+if %EXIT_CODE% equ 0 set EXIT_CODE=1
+if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
+exit /b %EXIT_CODE%
 
 :mainEnd
 if "%OS%"=="Windows_NT" endlocal

src/main/java/neureka/AbstractNda.java

@@ -167,7 +167,7 @@ private void _setDataAndCountUsage( Data<V> newData ) {
         if ( newData instanceof DeviceData )
             ( (DeviceData<?>) newData ).incrementUsageCount();
 
-        _data = newData; // This must be the only place where the data is set!!!
+        _data = ( newData != null ? newData : (Data<V>) Data.none()); // This must be the only place where the data is set!!!
     }
 
     protected <T> void _initDataArrayFrom( Filler<T> filler )
@@ -254,17 +254,13 @@ protected final void _allocateVirtual() {
      *
      * @return An {@link TensorConstructor} exposing a simple API for configuring a new {@link Tensor} instance.
      */
-    protected static TensorConstructor constructFor(AbstractNda<?, ?> nda, Device<?> targetDevice, NDConstructor ndConstructor )
+    protected static TensorConstructor constructFor( Device<?> targetDevice, NDConstructor ndConstructor )
     {
         return
-            new TensorConstructor(
-                targetDevice, ndConstructor,
-                new TensorConstructor.API() {
-                    @Override public void setConf( NDConfiguration conf   ) { nda.mut().setNDConf( conf ); }
-                    @Override public void setData( Data o                 ) { nda._setData( o ); }
-                    @Override public void setIsVirtual( boolean isVirtual ) { nda._setIsVirtual( isVirtual ); }
-                }
-            );
+                new TensorConstructor(
+                        targetDevice, ndConstructor,
+                        new TensorConstructor.Args()
+                );
     }
 
     /**
@@ -323,12 +319,7 @@ public boolean is( Class<?> typeClass ) {
     protected void _setNDConf( NDConfiguration ndConfiguration )
     {
         _guardSet( "ND-Configuration" );
-        if ( _NDConf != null && ndConfiguration != null ) {
-            int s1 = Arrays.stream( _NDConf.shape() ).map( Math::abs ).reduce( 1, ( a, b ) -> a * b );
-            int s2 = Arrays.stream( ndConfiguration.shape() ).map( Math::abs ).reduce( 1, ( a, b ) -> a * b );
-            assert s1 == s2;
-        }
-        _NDConf = ndConfiguration;
+        _NDConf = ( ndConfiguration != null ? ndConfiguration : NDConfiguration.none() );
     }
 
 }

src/main/java/neureka/Data.java

@@ -16,6 +16,17 @@
  */
 public interface Data<V>
 {
+    /**
+     *  This is a static factory method which returns a {@link Data} object
+     *  which does not contain any data. It is a sort of no-operation null object
+     *  which can be used to represent the absence of data.
+     *  A deleted tensor will typically have a {@link Data} object which does not contain any data.
+     *
+     * @return A {@link Data} object which does not contain any data.
+     */
+    static Data<Void> none() { return NoOpData.INSTANCE; }
+
+
     static <V> Data<V> of( Class<V> type, V... data ) { return CPU.get().allocate( type, data ); }
 
     static Data<Float> of( float... items ) { return CPU.get().allocate( Float.class, items ); }