diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index a91e89b..fbc85cd 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -6,9 +6,11 @@ name: CI # events but only for the master branch on: push: - branches: [ master ] + branches: + - 'master' pull_request: - branches: [ master ] + branches: + - '*' # A workflow run is made up of one or more jobs that can run sequentially or in parallel jobs: @@ -21,7 +23,9 @@ jobs: steps: # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - uses: actions/checkout@v2 - + with: + fetch-depth: 0 + - name: Set up JDK 1.8 uses: actions/setup-java@v1 with: @@ -32,7 +36,10 @@ jobs: - name: build & test run: ./gradlew check - + + - name: run diff coverage check + run: ./gradlew kombi-lib:diffCoverage -PdiffBase=refs/remotes/origin/master + - name: create coverage report run: ./gradlew jacocoTestReport diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 413604c..0000000 --- a/.travis.yml +++ /dev/null @@ -1,7 +0,0 @@ -language: java - -jdk: -- openjdk8 - -after_success: -- ./gradlew jacocoTestReport coveralls \ No newline at end of file diff --git a/README.md b/README.md index a2d2510..0c01c4c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # Kombi -[ ![Download](https://api.bintray.com/packages/sgnatiuk/kombi/kombi/images/download.svg) ](https://bintray.com/sgnatiuk/kombi/kombi/_latestVersion) -[![Build Status](https://travis-ci.org/SurpSG/Kombi.svg?branch=master)](https://travis-ci.org/SurpSG/Kombi) -[![Coverage Status](https://coveralls.io/repos/github/SurpSG/Kombi/badge.svg)](https://coveralls.io/github/SurpSG/Kombi) +[![](https://jitpack.io/v/surpsg/kombi.svg)](https://jitpack.io/#surpsg/kombi) +[![CI](https://github.com/SurpSG/Kombi/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/SurpSG/Kombi/actions/workflows/ci.yml) +[![codecov](https://codecov.io/gh/SurpSG/Kombi/branch/master/graph/badge.svg?token=DBG3XreExu)](https://codecov.io/gh/SurpSG/Kombi) +[![GitHub issues](https://img.shields.io/github/issues/surpsg/kombi)](https://github.com/surpsg/kombi/issues) +[![GitHub stars](https://img.shields.io/github/stars/surpsg/kombi?style=flat-square)](https://github.com/surpsg/kombi/stargazers) **Kombi** is library to generate * all possible [combinations](https://en.wikipedia.org/wiki/Combination) from given set of items @@ -16,26 +18,26 @@ To get even better throughput(see [Benchmarking](#benchmarking) section), comput ```xml - jcenter - https://jcenter.bintray.com/ + jitpack.io + https://jitpack.io com.sgnatiuk kombi - 3.0.1 + 3.1.0 ``` ### Gradle ```groovy -repositories { - jcenter() +repositories { + maven { url 'https://jitpack.io' } } dependencies { - compile 'com.sgnatiuk:kombi:3.0.1' + compile 'com.sgnatiuk:kombi:3.1.0' } ``` ## Combinations diff --git a/RELEASENOTES.md b/RELEASENOTES.md index 062102a..b0573a6 100644 --- a/RELEASENOTES.md +++ b/RELEASENOTES.md @@ -1,3 +1,8 @@ +v3.1.0 +* Speed up cartesian item generation +* Speed up cartesian item toArray() method +* Move Kombi to jitpack + v3.0.1 * 'Cartesian product' from Collection> performance tuning.(~40% speed-up) diff --git a/build.gradle b/build.gradle index 837bff5..5840cb4 100644 --- a/build.gradle +++ b/build.gradle @@ -1,5 +1,5 @@ buildscript { - ext.kotlin_version = '1.3.61' + ext.kotlin_version = '1.4.32' repositories { mavenCentral() @@ -22,4 +22,4 @@ allprojects { subprojects{ apply plugin: 'kotlin' apply plugin: 'java' -} \ No newline at end of file +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index 0890def..e708b1c 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index d7d5326..442d913 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,6 +1,5 @@ -#Sun Mar 25 20:32:19 EEST 2018 distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.3-bin.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-5.5.1-all.zip diff --git a/gradlew b/gradlew index 4453cce..4f906e0 100755 --- a/gradlew +++ b/gradlew @@ -1,5 +1,21 @@ #!/usr/bin/env sh +# +# Copyright 2015 the original author or authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + ############################################################################## ## ## Gradle start up script for UN*X @@ -28,16 +44,16 @@ APP_NAME="Gradle" APP_BASE_NAME=`basename "$0"` # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -DEFAULT_JVM_OPTS="" +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' # Use the maximum available, or set MAX_FD != -1 to use that value. MAX_FD="maximum" -warn ( ) { +warn () { echo "$*" } -die ( ) { +die () { echo echo "$*" echo @@ -66,6 +82,7 @@ esac CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + # Determine the Java command to use to start the JVM. if [ -n "$JAVA_HOME" ] ; then if [ -x "$JAVA_HOME/jre/sh/java" ] ; then @@ -109,10 +126,11 @@ if $darwin; then GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" fi -# For Cygwin, switch paths to Windows format before running java -if $cygwin ; then +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then APP_HOME=`cygpath --path --mixed "$APP_HOME"` CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` # We build the pattern for arguments to be converted via cygpath @@ -138,35 +156,30 @@ if $cygwin ; then else eval `echo args$i`="\"$arg\"" fi - i=$((i+1)) + i=`expr $i + 1` done case $i in - (0) set -- ;; - (1) set -- "$args0" ;; - (2) set -- "$args0" "$args1" ;; - (3) set -- "$args0" "$args1" "$args2" ;; - (4) set -- "$args0" "$args1" "$args2" "$args3" ;; - (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; - (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; - (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; - (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; - (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + 0) set -- ;; + 1) set -- "$args0" ;; + 2) set -- "$args0" "$args1" ;; + 3) set -- "$args0" "$args1" "$args2" ;; + 4) set -- "$args0" "$args1" "$args2" "$args3" ;; + 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; esac fi # Escape application args -save ( ) { +save () { for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done echo " " } -APP_ARGS=$(save "$@") +APP_ARGS=`save "$@"` # Collect all arguments for the java command, following the shell quoting and substitution rules eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" -# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong -if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then - cd "$(dirname "$0")" -fi - exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat index f955316..107acd3 100644 --- a/gradlew.bat +++ b/gradlew.bat @@ -1,3 +1,19 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + @if "%DEBUG%" == "" @echo off @rem ########################################################################## @rem @@ -13,15 +29,18 @@ if "%DIRNAME%" == "" set DIRNAME=. set APP_BASE_NAME=%~n0 set APP_HOME=%DIRNAME% +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -set DEFAULT_JVM_OPTS= +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" @rem Find java.exe if defined JAVA_HOME goto findJavaFromJavaHome set JAVA_EXE=java.exe %JAVA_EXE% -version >NUL 2>&1 -if "%ERRORLEVEL%" == "0" goto init +if "%ERRORLEVEL%" == "0" goto execute echo. echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. @@ -35,7 +54,7 @@ goto fail set JAVA_HOME=%JAVA_HOME:"=% set JAVA_EXE=%JAVA_HOME%/bin/java.exe -if exist "%JAVA_EXE%" goto init +if exist "%JAVA_EXE%" goto execute echo. echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% @@ -45,28 +64,14 @@ echo location of your Java installation. goto fail -:init -@rem Get command-line arguments, handling Windows variants - -if not "%OS%" == "Windows_NT" goto win9xME_args - -:win9xME_args -@rem Slurp the command line arguments. -set CMD_LINE_ARGS= -set _SKIP=2 - -:win9xME_args_slurp -if "x%~1" == "x" goto execute - -set CMD_LINE_ARGS=%* - :execute @rem Setup the command line set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + @rem Execute Gradle -"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* :end @rem End local scope for the variables with windows NT shell diff --git a/kombi-lib/bintray.gradle b/kombi-lib/bintray.gradle deleted file mode 100644 index 7a1897c..0000000 --- a/kombi-lib/bintray.gradle +++ /dev/null @@ -1,73 +0,0 @@ -import java.nio.file.Paths - -apply plugin: 'com.jfrog.bintray' -apply plugin: 'maven' -apply plugin: 'maven-publish' -apply plugin: 'java' - -def bintrayProperties = new Properties() -File propFile = Paths.get( - System.properties['user.home'].toString(), - ".gradle", - "bintray.properties").toFile() -if(propFile.exists()){ - bintrayProperties.load(propFile.newDataInputStream()) -} -bintray { - user = bintrayProperties["bintray.user"] - key = bintrayProperties["bintray.apikey"] - configurations = ['archives'] - pkg { - repo = 'kombi' - name = 'kombi' - userOrg = 'sgnatiuk' - licenses = ['Apache-2.0'] - vcsUrl = 'https://github.com/SurpSG/Kombi.git' - version { - name = libVersion - released = new Date() - vcsTag = libVersion - } - } - publications = ['bintrayPublish'] -} - -jar.baseName = libName -task sourcesJar(type: Jar, dependsOn: project.classes) { - from sourceSets.main.allSource - classifier = 'sources' - baseName = libName -} - -task javadocJar(type: Jar, dependsOn: project.javadoc) { - from javadoc.destinationDir - classifier = 'javadoc' - baseName = libName -} - -artifacts { - archives sourcesJar, javadocJar -} - -publishing { - publications { - bintrayPublish(MavenPublication) { - artifactId libName - groupId libPackage - version libVersion - from components.java - - artifact sourcesJar - artifact javadocJar - - pom.withXml { - asNode().dependencies.each() { - it.parent().remove(it) - } - } - } - } -} - - - diff --git a/kombi-lib/build.gradle b/kombi-lib/build.gradle index 69c85ee..19d8714 100644 --- a/kombi-lib/build.gradle +++ b/kombi-lib/build.gradle @@ -1,19 +1,21 @@ buildscript { repositories { jcenter() + maven { url 'https://jitpack.io' } } dependencies { classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.8.4' + classpath 'com.github.form-com.diff-coverage-gradle:diff-coverage:0.7.1' } } plugins { id 'jacoco' - id 'com.github.kt3k.coveralls' version '2.6.3' + id 'maven' } ext{ - libVersion = '3.0.1' + libVersion = '3.1.0' libPackage = 'com.sgnatiuk' libName = 'kombi' } @@ -21,6 +23,22 @@ ext{ group libPackage version libVersion +sourceCompatibility = 1.8 + +task sourcesJar(type: Jar, dependsOn: classes) { + classifier 'sources' + from sourceSets.main.allSource +} +task javadocJar(type: Jar, dependsOn: javadoc) { + classifier 'javadoc' + from javadoc.destinationDir +} + +artifacts { + archives sourcesJar + archives javadocJar +} + dependencies { testCompile "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version" testCompile "junit:junit:4.12" @@ -33,8 +51,24 @@ jacocoTestReport { } } -coveralls { - sourceDirs = files(sourceSets.main.kotlin.srcDirs).files.absolutePath -} +apply plugin: 'com.form.diff-coverage' +diffCoverageReport { + def diffBase = project.hasProperty('diffBase') ? project.diffBase : 'HEAD' -apply from: 'bintray.gradle' \ No newline at end of file + diffSource.git.compareWith diffBase + jacocoExecFiles = files(jacocoTestReport.executionData) + classesDirs = files(jacocoTestReport.classDirectories) + srcDirs = files(jacocoTestReport.sourceDirectories) + + reports { + html = true + baseReportDir = project.buildDir.absolutePath + } + + violationRules { + minBranches = 0.9 + minLines = 0.9 + minInstructions = 0.9 + failOnViolation = true + } +} diff --git a/kombi-lib/src/main/java/com/sgnatiuk/cartesian/CartesianProductSet.java b/kombi-lib/src/main/java/com/sgnatiuk/cartesian/CartesianProductSet.java index b980b09..1b2634b 100644 --- a/kombi-lib/src/main/java/com/sgnatiuk/cartesian/CartesianProductSet.java +++ b/kombi-lib/src/main/java/com/sgnatiuk/cartesian/CartesianProductSet.java @@ -58,11 +58,20 @@ public T get(int index) { return (T) valuesArr[index][localEncoded[index]]; } + @Override + public Object[] toArray() { + Object[] result = new Object[localEncoded.length]; + for (int i = 0; i < localEncoded.length; i++) { + result[i] = get(i); + } + return result; + } + @Override public Iterator iterator() { return new Iterator() { int index = 0; - int size = localEncoded.length; + final int size = localEncoded.length; @Override public boolean hasNext() { @@ -131,4 +140,4 @@ public int compare(Object[] o1, Object[] o2) { return o2.length - o1.length; } } -} \ No newline at end of file +} diff --git a/kombi-lib/src/main/java/com/sgnatiuk/cartesian/CombinationMask.java b/kombi-lib/src/main/java/com/sgnatiuk/cartesian/CombinationMask.java index fb251cf..b83bfe9 100644 --- a/kombi-lib/src/main/java/com/sgnatiuk/cartesian/CombinationMask.java +++ b/kombi-lib/src/main/java/com/sgnatiuk/cartesian/CombinationMask.java @@ -33,15 +33,17 @@ public int[] next() { * @return true if encoded was overflowed, otherwise false */ private boolean increment() { - int overflow = 1; int index = 0; - do { - int incrementedCell = mask[index] + overflow; - mask[index] = incrementedCell % bases[index]; - overflow = incrementedCell / bases[index++]; - } while (overflow != 0 && index < bases.length); - - return overflow > 0; + int incrementedCell = mask[index] + 1; + if (incrementedCell == bases[index]) { + mask[index++] = 0; + } else { + mask[index] = incrementedCell; + return false; + } + } while (index < bases.length); + + return true; } } diff --git a/kombi-lib/src/test/kotlin/com/sgnatiuk/cartesian/CartesianProductMapTest.kt b/kombi-lib/src/test/kotlin/com/sgnatiuk/cartesian/CartesianProductMapTest.kt index 6f74ab9..3f78bed 100644 --- a/kombi-lib/src/test/kotlin/com/sgnatiuk/cartesian/CartesianProductMapTest.kt +++ b/kombi-lib/src/test/kotlin/com/sgnatiuk/cartesian/CartesianProductMapTest.kt @@ -101,14 +101,11 @@ internal class CartesianProductMapTest { @Test fun `parallel stream should generate all items`() { - val threads = mutableSetOf() val cartesianProduct = cartesianProductOf(dataMap) val actual = cartesianProduct.stream() .parallel() - .peek { threads += Thread.currentThread().id } .collect(Collectors.toSet()) assertEquals(expectedCartesianMap.toSet(), actual) - assertTrue(threads.size > 1) } -} \ No newline at end of file +} diff --git a/kombi-lib/src/test/kotlin/com/sgnatiuk/cartesian/CartesianProductSetTest.kt b/kombi-lib/src/test/kotlin/com/sgnatiuk/cartesian/CartesianProductSetTest.kt index b682afa..206cb9a 100644 --- a/kombi-lib/src/test/kotlin/com/sgnatiuk/cartesian/CartesianProductSetTest.kt +++ b/kombi-lib/src/test/kotlin/com/sgnatiuk/cartesian/CartesianProductSetTest.kt @@ -7,6 +7,7 @@ import com.sgnatiuk.extensions.BigInt import org.junit.Assert.assertEquals import org.junit.Assert.assertTrue import org.junit.Test +import java.util.* import java.util.stream.Collectors internal class CartesianProductSetTest { @@ -68,6 +69,32 @@ internal class CartesianProductSetTest { assertContainsAll(expectedCartesianList, result) } + @Test + fun `toArray on cartesian item must return array of items`() { + val result: List> = cartesianProductOf(dataList, true).toList() + + val itemsAsArray: List> = result.asSequence() + .map { it as AbstractList }.map { it.toArray() } + .toList() + + expectedCartesianList.asSequence() + .map { it as AbstractList }.map { it.toArray() } + .forEach { expectedCombination: Array -> + var foundCombination = false + for (computed in itemsAsArray) { + if (computed contentEquals expectedCombination) { + foundCombination = true + break + } + } + assertTrue( + "Expected ${expectedCombination.contentToString()}, but not found in " + + itemsAsArray.joinToString { it.contentToString() }, + foundCombination + ) + } + } + @Test fun `verify Cartesian product set with keep order returns all possible combinations`() { val result: List> = cartesianProductOf(dataList, true).toList() @@ -167,4 +194,4 @@ internal class CartesianProductSetTest { } } } -} \ No newline at end of file +}