naming fix and doc update

This commit is contained in:
Alexander Nozik 2021-05-14 09:32:24 +03:00
parent 1a615c503d
commit dc9ec54644
6 changed files with 30 additions and 26 deletions

View File

@ -13,6 +13,7 @@
- Extended operations for ND4J fields - Extended operations for ND4J fields
- Jupyter Notebook integration module (kmath-jupyter) - Jupyter Notebook integration module (kmath-jupyter)
- `@PerformancePitfall` annotation to mark possibly slow API - `@PerformancePitfall` annotation to mark possibly slow API
- BigInt operation performance improvement and fixes by @zhelenskiy (#328)
### Changed ### Changed
- Exponential operations merged with hyperbolic functions - Exponential operations merged with hyperbolic functions

View File

@ -1020,7 +1020,7 @@ public final class space/kscience/kmath/operations/AlgebraExtensionsKt {
public static final fun averageWith (Ljava/lang/Iterable;Lspace/kscience/kmath/operations/Ring;)Ljava/lang/Object; public static final fun averageWith (Ljava/lang/Iterable;Lspace/kscience/kmath/operations/Ring;)Ljava/lang/Object;
public static final fun averageWith (Lkotlin/sequences/Sequence;Lspace/kscience/kmath/operations/Ring;)Ljava/lang/Object; public static final fun averageWith (Lkotlin/sequences/Sequence;Lspace/kscience/kmath/operations/Ring;)Ljava/lang/Object;
public static final fun power (Lspace/kscience/kmath/operations/Field;Ljava/lang/Object;I)Ljava/lang/Object; public static final fun power (Lspace/kscience/kmath/operations/Field;Ljava/lang/Object;I)Ljava/lang/Object;
public static final fun power (Lspace/kscience/kmath/operations/Ring;Ljava/lang/Object;I)Ljava/lang/Object; public static final fun power-jXDDuk8 (Lspace/kscience/kmath/operations/Ring;Ljava/lang/Object;I)Ljava/lang/Object;
public static final fun sum (Lspace/kscience/kmath/operations/Ring;Ljava/lang/Iterable;)Ljava/lang/Object; public static final fun sum (Lspace/kscience/kmath/operations/Ring;Ljava/lang/Iterable;)Ljava/lang/Object;
public static final fun sum (Lspace/kscience/kmath/operations/Ring;Lkotlin/sequences/Sequence;)Ljava/lang/Object; public static final fun sum (Lspace/kscience/kmath/operations/Ring;Lkotlin/sequences/Sequence;)Ljava/lang/Object;
public static final fun sumWith (Ljava/lang/Iterable;Lspace/kscience/kmath/operations/Ring;)Ljava/lang/Object; public static final fun sumWith (Ljava/lang/Iterable;Lspace/kscience/kmath/operations/Ring;)Ljava/lang/Object;
@ -1050,6 +1050,7 @@ public final class space/kscience/kmath/operations/BigInt : java/lang/Comparable
public final fun modPow (Lspace/kscience/kmath/operations/BigInt;Lspace/kscience/kmath/operations/BigInt;)Lspace/kscience/kmath/operations/BigInt; public final fun modPow (Lspace/kscience/kmath/operations/BigInt;Lspace/kscience/kmath/operations/BigInt;)Lspace/kscience/kmath/operations/BigInt;
public final fun or (Lspace/kscience/kmath/operations/BigInt;)Lspace/kscience/kmath/operations/BigInt; public final fun or (Lspace/kscience/kmath/operations/BigInt;)Lspace/kscience/kmath/operations/BigInt;
public final fun plus (Lspace/kscience/kmath/operations/BigInt;)Lspace/kscience/kmath/operations/BigInt; public final fun plus (Lspace/kscience/kmath/operations/BigInt;)Lspace/kscience/kmath/operations/BigInt;
public final fun pow-WZ4Q5Ns (I)Lspace/kscience/kmath/operations/BigInt;
public final fun rem (I)I public final fun rem (I)I
public final fun rem (Lspace/kscience/kmath/operations/BigInt;)Lspace/kscience/kmath/operations/BigInt; public final fun rem (Lspace/kscience/kmath/operations/BigInt;)Lspace/kscience/kmath/operations/BigInt;
public final fun shl (I)Lspace/kscience/kmath/operations/BigInt; public final fun shl (I)Lspace/kscience/kmath/operations/BigInt;

View File

@ -98,7 +98,7 @@ public class BigInt internal constructor(
else -> BigInt(sign, multiplyMagnitudeByUInt(magnitude, other)) else -> BigInt(sign, multiplyMagnitudeByUInt(magnitude, other))
} }
public fun pow(exponent: UInt): BigInt = BigIntField.power(this@BigInt, exponent) public fun pow(exponent: UInt): BigInt = BigIntField.power(this, exponent)
public operator fun times(other: Int): BigInt = when { public operator fun times(other: Int): BigInt = when {
other > 0 -> this * kotlin.math.abs(other).toUInt() other > 0 -> this * kotlin.math.abs(other).toUInt()

View File

@ -97,21 +97,21 @@ public fun <T, S> Sequence<T>.averageWith(space: S): T where S : Ring<T>, S : Sc
//TODO optimized power operation //TODO optimized power operation
/** /**
* Raises [arg] to the non-negative integer power [power]. * Raises [arg] to the non-negative integer power [exponent].
* *
* Special case: 0 ^ 0 is 1. * Special case: 0 ^ 0 is 1.
* *
* @receiver the algebra to provide multiplication. * @receiver the algebra to provide multiplication.
* @param arg the base. * @param arg the base.
* @param power the exponent. * @param exponent the exponent.
* @return the base raised to the power. * @return the base raised to the power.
* @author Evgeniy Zhelenskiy * @author Evgeniy Zhelenskiy
*/ */
public fun <T> Ring<T>.power(arg: T, power: UInt): T = when { public fun <T> Ring<T>.power(arg: T, exponent: UInt): T = when {
arg == zero && power > 0U -> zero arg == zero && exponent > 0U -> zero
arg == one -> arg arg == one -> arg
arg == -one -> powWithoutOptimization(arg, power % 2U) arg == -one -> powWithoutOptimization(arg, exponent % 2U)
else -> powWithoutOptimization(arg, power) else -> powWithoutOptimization(arg, exponent)
} }
private fun <T> Ring<T>.powWithoutOptimization(base: T, exponent: UInt): T = when (exponent) { private fun <T> Ring<T>.powWithoutOptimization(base: T, exponent: UInt): T = when (exponent) {
@ -125,17 +125,17 @@ private fun <T> Ring<T>.powWithoutOptimization(base: T, exponent: UInt): T = whe
/** /**
* Raises [arg] to the integer power [power]. * Raises [arg] to the integer power [exponent].
* *
* Special case: 0 ^ 0 is 1. * Special case: 0 ^ 0 is 1.
* *
* @receiver the algebra to provide multiplication and division. * @receiver the algebra to provide multiplication and division.
* @param arg the base. * @param arg the base.
* @param power the exponent. * @param exponent the exponent.
* @return the base raised to the power. * @return the base raised to the power.
* @author Iaroslav Postovalov, Evgeniy Zhelenskiy * @author Iaroslav Postovalov, Evgeniy Zhelenskiy
*/ */
public fun <T> Field<T>.power(arg: T, power: Int): T = when { public fun <T> Field<T>.power(arg: T, exponent: Int): T = when {
power < 0 -> one / (this as Ring<T>).power(arg, if (power == Int.MIN_VALUE) Int.MAX_VALUE.toUInt().inc() else (-power).toUInt()) exponent < 0 -> one / (this as Ring<T>).power(arg, if (exponent == Int.MIN_VALUE) Int.MAX_VALUE.toUInt().inc() else (-exponent).toUInt())
else -> (this as Ring<T>).power(arg, power.toUInt()) else -> (this as Ring<T>).power(arg, exponent.toUInt())
} }

View File

@ -7,7 +7,10 @@ package space.kscience.kmath.operations
import kotlin.random.Random import kotlin.random.Random
import kotlin.random.nextUInt import kotlin.random.nextUInt
import kotlin.test.* import kotlin.test.Test
import kotlin.test.assertContentEquals
import kotlin.test.assertEquals
import kotlin.test.assertFalse
@kotlin.ExperimentalUnsignedTypes @kotlin.ExperimentalUnsignedTypes
class BigIntOperationsTest { class BigIntOperationsTest {
@ -153,15 +156,14 @@ class BigIntOperationsTest {
@Test @Test
fun testKaratsuba() { fun testKaratsuba() {
val random = Random(2222)
val x = uintArrayOf(12U, 345U) val x = uintArrayOf(12U, 345U)
val y = uintArrayOf(6U, 789U) val y = uintArrayOf(6U, 789U)
assertContentEquals(BigInt.naiveMultiplyMagnitudes(x, y), BigInt.karatsubaMultiplyMagnitudes(x, y)) assertContentEquals(BigInt.naiveMultiplyMagnitudes(x, y), BigInt.karatsubaMultiplyMagnitudes(x, y))
repeat(1000) { val x1 = UIntArray(Random.nextInt(100, 1000)) { random.nextUInt() }
val x1 = UIntArray(Random.nextInt(100, 1000)) { Random.nextUInt() } val y1 = UIntArray(Random.nextInt(100, 1000)) { random.nextUInt() }
val y1 = UIntArray(Random.nextInt(100, 1000)) { Random.nextUInt() }
assertContentEquals(BigInt.naiveMultiplyMagnitudes(x1, y1), BigInt.karatsubaMultiplyMagnitudes(x1, y1)) assertContentEquals(BigInt.naiveMultiplyMagnitudes(x1, y1), BigInt.karatsubaMultiplyMagnitudes(x1, y1))
} }
}
@Test @Test
fun test_shr_20() { fun test_shr_20() {

View File

@ -22,12 +22,12 @@ internal class DoubleFieldTest {
@Test @Test
fun testPow() = DoubleField { fun testPow() = DoubleField {
val num = 5 * one val num = 5 * one
assertEquals(5.0, power(num, 1)) assertEquals(5.0, power(num, 1), 0.01)
assertEquals(25.0, power(num, 2)) assertEquals(25.0, power(num, 2), 0.01)
assertEquals(1.0, power(num, 0)) assertEquals(1.0, power(num, 0), 0.01)
assertEquals(0.2, power(num, -1)) assertEquals(0.2, power(num, -1), 0.01)
assertEquals(0.04, power(num, -2)) assertEquals(0.04, power(num, -2), 0.01)
assertEquals(0.0, power(num, Int.MIN_VALUE)) assertEquals(0.0, power(num, Int.MIN_VALUE), 0.01)
assertEquals(1.0, power(zero, 0)) assertEquals(1.0, power(zero, 0), 0.01)
} }
} }