Optimize FeedBuffer.update (#164)

.github/workflows/CI.yml

@@ -52,7 +52,7 @@ jobs:
         uses: actions/upload-artifact@v4
         if: ${{ always() }}
         with:
-          name: test-report-${{ matrix.os }}-java${{ matrix.java-version }}
+          name: test-report-${{ matrix.os }}
           path: '**/build/reports/tests/**'
           retention-days: 1
 

benchmarks/src/commonMain/kotlin/io/matthewnelson/encoding/benchmarks/Constants.kt

@@ -15,7 +15,7 @@
  **/
 package io.matthewnelson.encoding.benchmarks
 
-const val ENC_ITERATIONS_WARMUP = 5
-const val ENC_ITERATIONS_MEASURE = 5
-const val ENC_TIME_WARMUP = 2
-const val ENC_TIME_MEASURE = 3
+const val ITERATIONS_WARMUP = 5
+const val ITERATIONS_MEASURE = 5
+const val TIME_WARMUP = 2
+const val TIME_MEASURE = 3

benchmarks/src/commonMain/kotlin/io/matthewnelson/encoding/benchmarks/EncoderDecoderOpts.kt → benchmarks/src/commonMain/kotlin/io/matthewnelson/encoding/benchmarks/EncoderDecoderOps.kt

@@ -13,6 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  **/
+@file:Suppress("unused")
+
 package io.matthewnelson.encoding.benchmarks
 
 import io.matthewnelson.encoding.base16.Base16
@@ -56,8 +58,8 @@ abstract class EncoderDecoderBenchmarkBase {
 @State(Scope.Benchmark)
 @BenchmarkMode(Mode.AverageTime)
 @OutputTimeUnit(BenchmarkTimeUnit.NANOSECONDS)
-@Warmup(iterations = ENC_ITERATIONS_WARMUP, time = ENC_TIME_WARMUP)
-@Measurement(iterations = ENC_ITERATIONS_MEASURE, time = ENC_TIME_MEASURE)
+@Warmup(iterations = ITERATIONS_WARMUP, time = TIME_WARMUP)
+@Measurement(iterations = ITERATIONS_MEASURE, time = TIME_MEASURE)
 open class Base16Benchmark: EncoderDecoderBenchmarkBase() {
     // CHARS: 0123456789ABCDEF
     @Param("3:0", "d:122")
@@ -68,8 +70,8 @@ open class Base16Benchmark: EncoderDecoderBenchmarkBase() {
 @State(Scope.Benchmark)
 @BenchmarkMode(Mode.AverageTime)
 @OutputTimeUnit(BenchmarkTimeUnit.NANOSECONDS)
-@Warmup(iterations = ENC_ITERATIONS_WARMUP, time = ENC_TIME_WARMUP)
-@Measurement(iterations = ENC_ITERATIONS_MEASURE, time = ENC_TIME_MEASURE)
+@Warmup(iterations = ITERATIONS_WARMUP, time = TIME_WARMUP)
+@Measurement(iterations = ITERATIONS_MEASURE, time = TIME_MEASURE)
 open class Base32CrockfordBenchmark: EncoderDecoderBenchmarkBase() {
     // CHARS: 0123456789ABCDEFGHJKMNPQRSTVWXYZ
     @Param("3:-6", "x:115")
@@ -80,8 +82,8 @@ open class Base32CrockfordBenchmark: EncoderDecoderBenchmarkBase() {
 @State(Scope.Benchmark)
 @BenchmarkMode(Mode.AverageTime)
 @OutputTimeUnit(BenchmarkTimeUnit.NANOSECONDS)
-@Warmup(iterations = ENC_ITERATIONS_WARMUP, time = ENC_TIME_WARMUP)
-@Measurement(iterations = ENC_ITERATIONS_MEASURE, time = ENC_TIME_MEASURE)
+@Warmup(iterations = ITERATIONS_WARMUP, time = TIME_WARMUP)
+@Measurement(iterations = ITERATIONS_MEASURE, time = TIME_MEASURE)
 open class Base32DefaultBenchmark: EncoderDecoderBenchmarkBase() {
     // CHARS: ABCDEFGHIJKLMNOPQRSTUVWXYZ234567
     @Param("C:-123", "w:15")
@@ -92,8 +94,8 @@ open class Base32DefaultBenchmark: EncoderDecoderBenchmarkBase() {
 @State(Scope.Benchmark)
 @BenchmarkMode(Mode.AverageTime)
 @OutputTimeUnit(BenchmarkTimeUnit.NANOSECONDS)
-@Warmup(iterations = ENC_ITERATIONS_WARMUP, time = ENC_TIME_WARMUP)
-@Measurement(iterations = ENC_ITERATIONS_MEASURE, time = ENC_TIME_MEASURE)
+@Warmup(iterations = ITERATIONS_WARMUP, time = TIME_WARMUP)
+@Measurement(iterations = ITERATIONS_MEASURE, time = TIME_MEASURE)
 open class Base32HexBenchmark: EncoderDecoderBenchmarkBase() {
     // CHARS: 0123456789ABCDEFGHIJKLMNOPQRSTUV
     @Param("A:-12", "r:42")
@@ -104,8 +106,8 @@ open class Base32HexBenchmark: EncoderDecoderBenchmarkBase() {
 @State(Scope.Benchmark)
 @BenchmarkMode(Mode.AverageTime)
 @OutputTimeUnit(BenchmarkTimeUnit.NANOSECONDS)
-@Warmup(iterations = ENC_ITERATIONS_WARMUP, time = ENC_TIME_WARMUP)
-@Measurement(iterations = ENC_ITERATIONS_MEASURE, time = ENC_TIME_MEASURE)
+@Warmup(iterations = ITERATIONS_WARMUP, time = TIME_WARMUP)
+@Measurement(iterations = ITERATIONS_MEASURE, time = TIME_MEASURE)
 open class Base64Benchmark: EncoderDecoderBenchmarkBase() {
     // CHARS: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789
     @Param("2:84", "w:22")

benchmarks/src/commonMain/kotlin/io/matthewnelson/encoding/benchmarks/FeedBufferBenchmark.kt

@@ -13,16 +13,18 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  **/
+@file:Suppress("unused")
+
 package io.matthewnelson.encoding.benchmarks
 
 import io.matthewnelson.encoding.core.util.FeedBuffer
 import kotlinx.benchmark.*
 
 @State(Scope.Benchmark)
 @BenchmarkMode(Mode.AverageTime)
-@Warmup(iterations = 5, time = 1)
-@Measurement(iterations = 5, time = 2)
 @OutputTimeUnit(BenchmarkTimeUnit.NANOSECONDS)
+@Warmup(iterations = ITERATIONS_WARMUP, time = TIME_WARMUP)
+@Measurement(iterations = ITERATIONS_MEASURE, time = TIME_MEASURE)
 open class FeedBufferBenchmark {
 
     private val buffer = object : FeedBuffer(
@@ -32,7 +34,5 @@ open class FeedBufferBenchmark {
     ) {}
 
     @Benchmark
-    fun update() {
-        repeat(buffer.blockSize) { buffer.update(it) }
-    }
+    fun update() { buffer.update(42) }
 }

library/core/src/commonMain/kotlin/io/matthewnelson/encoding/core/Decoder.kt

@@ -70,6 +70,7 @@ public sealed class Decoder<C: EncoderDecoder.Config>(public val config: C) {
      * @see [EncoderDecoder.Feed.doFinal]
      * */
     public abstract inner class Feed: EncoderDecoder.Feed<C>(config) {
+
         private var isClosed = false
         private var isPaddingSet = false
 
@@ -138,11 +139,12 @@ public sealed class Decoder<C: EncoderDecoder.Config>(public val config: C) {
 
         public final override fun close() { isClosed = true }
         public final override fun isClosed(): Boolean = isClosed
-        /** @suppress */
-        public final override fun toString(): String = "${this@Decoder}.Decoder.Feed@${hashCode()}"
 
         @Throws(EncodingException::class)
         protected abstract fun consumeProtected(input: Char)
+
+        /** @suppress */
+        public final override fun toString(): String = "${this@Decoder}.Decoder.Feed@${hashCode()}"
     }
 
     /**

library/core/src/commonMain/kotlin/io/matthewnelson/encoding/core/Encoder.kt

@@ -80,6 +80,7 @@ public sealed class Encoder<C: EncoderDecoder.Config>(config: C): Decoder<C>(con
      * @see [EncoderDecoder.Feed.doFinal]
      * */
     public abstract inner class Feed: EncoderDecoder.Feed<C>(config) {
+
         private var isClosed = false
 
         /**
@@ -124,11 +125,12 @@ public sealed class Encoder<C: EncoderDecoder.Config>(config: C): Decoder<C>(con
 
         public final override fun close() { isClosed = true }
         public final override fun isClosed(): Boolean = isClosed
-        /** @suppress */
-        public final override fun toString(): String = "${this@Encoder}.Encoder.Feed@${hashCode()}"
 
         protected abstract fun consumeProtected(input: Byte)
         protected abstract override fun doFinalProtected()
+
+        /** @suppress */
+        public final override fun toString(): String = "${this@Encoder}.Encoder.Feed@${hashCode()}"
     }
 
     /**

library/core/src/commonMain/kotlin/io/matthewnelson/encoding/core/EncoderDecoder.kt

@@ -110,10 +110,10 @@ public abstract class EncoderDecoder<C: EncoderDecoder.Config>(config: C): Encod
             }
 
             if (lineBreakInterval > 0) {
-                var lineBreakCount: Float = (outSize / lineBreakInterval) - 1F
+                var lineBreakCount: Double = (outSize / lineBreakInterval) - 1.0
 
-                if (lineBreakCount > 0F) {
-                    if (lineBreakCount.rem(1) > 0F) {
+                if (lineBreakCount > 0.0) {
+                    if (lineBreakCount.rem(1.0) > 0.0) {
                         lineBreakCount++
                     }
 
@@ -303,16 +303,9 @@ public abstract class EncoderDecoder<C: EncoderDecoder.Config>(config: C): Encod
             public val name: String = name.trim()
 
             /** @suppress */
-            override fun equals(other: Any?): Boolean {
-                return  other is Setting
-                        && other.name == name
-            }
-
+            override fun equals(other: Any?): Boolean = other is Setting && other.name == name
             /** @suppress */
-            override fun hashCode(): Int {
-                return 17 * 31 + name.hashCode()
-            }
-
+            override fun hashCode(): Int = 17 * 31 + name.hashCode()
             /** @suppress */
             override fun toString(): String = "$name: $value"
         }

library/core/src/commonMain/kotlin/io/matthewnelson/encoding/core/internal/-EncoderDecoder.kt

@@ -25,6 +25,8 @@ import kotlin.contracts.InvocationKind
 import kotlin.contracts.contract
 import kotlin.math.min
 
+private const val MAX_ENCODE_OUT_SIZE: Long = Int.MAX_VALUE.toLong()
+
 @Suppress("NOTHING_TO_INLINE")
 @Throws(EncodingException::class)
 @OptIn(ExperimentalContracts::class)
@@ -37,32 +39,25 @@ internal inline fun <C: Config> Decoder<C>.decode(
     }
 
     val size = config.decodeOutMaxSizeOrFail(input)
-    val ba = ByteArray(size)
+    val a = ByteArray(size)
 
     var i = 0
     try {
-        newDecoderFeed { decodedByte ->
-            try {
-                ba[i++] = decodedByte
-            } catch (e: IndexOutOfBoundsException) {
-                // Something is wrong with the encoder's pre-calculation
-                throw EncodingSizeException("Encoder's pre-calculation of Size[$size] was incorrect", e)
-            }
-        }.use { feed ->
-            action.invoke(feed)
-        }
+        newDecoderFeed(out = { b -> a[i++] = b }).use { feed -> action.invoke(feed) }
     } catch (t: Throwable) {
-        ba.fill(0, toIndex = min(ba.size, i))
+        a.fill(0, toIndex = min(a.size, i))
+        if (t is IndexOutOfBoundsException && i >= size) {
+            // Something is wrong with the encoder's pre-calculation
+            throw EncodingSizeException("Encoder's pre-calculation of Size[$size] was incorrect", t)
+        }
         throw t
     }
 
-    return if (i == size) {
-        ba
-    } else {
-        val copy = ba.copyOf(i)
-        ba.fill(0, toIndex = i)
-        copy
-    }
+    if (i == size) return a
+
+    val copy = a.copyOf(i)
+    a.fill(0, i)
+    return copy
 }
 
 /**
@@ -80,8 +75,8 @@ internal inline fun <T: Any> Encoder<*>.encodeOutSizeOrFail(
     }
 
     val outSize = config.encodeOutSize(size.toLong())
-    if (outSize > Int.MAX_VALUE.toLong()) {
-        throw Config.outSizeExceedsMaxEncodingSizeException(outSize, Int.MAX_VALUE)
+    if (outSize > MAX_ENCODE_OUT_SIZE) {
+        throw Config.outSizeExceedsMaxEncodingSizeException(outSize, MAX_ENCODE_OUT_SIZE)
     }
 
     return block.invoke(outSize.toInt())
@@ -93,10 +88,7 @@ internal inline fun <C: Config> Encoder<C>.encode(
     out: Encoder.OutFeed,
 ) {
     if (data.isEmpty()) return
-
-    newEncoderFeed(out).use { feed ->
-        data.forEach { b -> feed.consume(b) }
-    }
+    newEncoderFeed(out).use { feed -> data.forEach { b -> feed.consume(b) } }
 }
 
 @Suppress("NOTHING_TO_INLINE")
@@ -105,8 +97,6 @@ internal inline fun EncoderDecoder.Feed<*>.closedException(): EncodingException
 }
 
 @Suppress("NOTHING_TO_INLINE", "UnusedReceiverParameter")
-internal inline fun Config.calculatedOutputNegativeEncodingSizeException(
-    outSize: Number
-): EncodingSizeException {
+internal inline fun Config.calculatedOutputNegativeEncodingSizeException(outSize: Number): EncodingSizeException {
     return EncodingSizeException("Calculated output of Size[$outSize] was negative")
 }

library/core/src/commonMain/kotlin/io/matthewnelson/encoding/core/util/FeedBuffer.kt

@@ -61,12 +61,10 @@ constructor(
      * to output data once the [buffer] fills.
      * */
     public fun update(input: Int) {
-        buffer[count] = input
-
-        if (++count % blockSize == 0) {
-            flush.invoke(buffer)
-            count = 0
-        }
+        buffer[count++] = input
+        if (count != blockSize) return
+        flush.invoke(buffer)
+        count = 0
     }
 
     /**