Document ShapeND.asArray()

2024-04-15 18:01:58 +03:00 · 2024-04-15 18:01:58 +03:00 · fc0393436f
commit fc0393436f
parent 9228e6019c
1 changed files with 3 additions and 0 deletions
--- a/kmath-core/src/commonMain/kotlin/space/kscience/kmath/nd/ShapeND.kt
+++ b/kmath-core/src/commonMain/kotlin/space/kscience/kmath/nd/ShapeND.kt
@ -68,6 +68,9 @@ public operator fun ShapeND.component3(): Int = get(2)
 */
 public fun ShapeND.toArray(): IntArray = array.copyOf()

+/**
+ * Provide internal content of [ShapeND]. Must not be modified.
+ */
@UnsafeKMathAPI
 public fun ShapeND.asArray(): IntArray = array