Document ShapeND.asArray()

SciProgCentre · Apr 15, 2024 · fc03934 · fc03934
1 parent 9228e60
commit fc03934
Showing 1 changed file with 3 additions and 0 deletions.
diff --git 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