diff --git a/CHANGES b/CHANGES index f47fc37..2981fb6 100644 --- a/CHANGES +++ b/CHANGES @@ -6,6 +6,8 @@ Here you can see the full list of changes between each npy release. Version 0.3.1 ------------- +Released on September 21th, 2016 + - Changed 'NpyFile.write' and 'NpzFile.Writer.write' to work in constant amount of memory. - Allowed writing arrays using a non-native byte order. diff --git a/README.md b/README.md index c2a70a0..f7c2079 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ repositories { } dependencies { - compile 'org.jetbrains.bio:npy:0.3.0' + compile 'org.jetbrains.bio:npy:0.3.1' } ``` diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/as-boolean-array.md b/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/as-boolean-array.md deleted file mode 100644 index e20b52d..0000000 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/as-boolean-array.md +++ /dev/null @@ -1,5 +0,0 @@ -[0.3.0](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [asBooleanArray](.) - -# asBooleanArray - -`fun asBooleanArray(): BooleanArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L320) \ No newline at end of file diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/as-byte-array.md b/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/as-byte-array.md deleted file mode 100644 index 3842147..0000000 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/as-byte-array.md +++ /dev/null @@ -1,5 +0,0 @@ -[0.3.0](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [asByteArray](.) - -# asByteArray - -`fun asByteArray(): ByteArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L322) \ No newline at end of file diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/as-double-array.md b/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/as-double-array.md deleted file mode 100644 index 472d052..0000000 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/as-double-array.md +++ /dev/null @@ -1,5 +0,0 @@ -[0.3.0](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [asDoubleArray](.) - -# asDoubleArray - -`fun asDoubleArray(): DoubleArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L332) \ No newline at end of file diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/as-float-array.md b/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/as-float-array.md deleted file mode 100644 index 3417c2f..0000000 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/as-float-array.md +++ /dev/null @@ -1,5 +0,0 @@ -[0.3.0](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [asFloatArray](.) - -# asFloatArray - -`fun asFloatArray(): FloatArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L330) \ No newline at end of file diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/as-int-array.md b/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/as-int-array.md deleted file mode 100644 index fcd8385..0000000 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/as-int-array.md +++ /dev/null @@ -1,5 +0,0 @@ -[0.3.0](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [asIntArray](.) - -# asIntArray - -`fun asIntArray(): IntArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L326) \ No newline at end of file diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/as-long-array.md b/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/as-long-array.md deleted file mode 100644 index 5710446..0000000 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/as-long-array.md +++ /dev/null @@ -1,5 +0,0 @@ -[0.3.0](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [asLongArray](.) - -# asLongArray - -`fun asLongArray(): LongArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L328) \ No newline at end of file diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/as-short-array.md b/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/as-short-array.md deleted file mode 100644 index 7c3648b..0000000 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/as-short-array.md +++ /dev/null @@ -1,5 +0,0 @@ -[0.3.0](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [asShortArray](.) - -# asShortArray - -`fun asShortArray(): ShortArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L324) \ No newline at end of file diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/as-string-array.md b/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/as-string-array.md deleted file mode 100644 index 75fa87a..0000000 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/as-string-array.md +++ /dev/null @@ -1,5 +0,0 @@ -[0.3.0](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [asStringArray](.) - -# asStringArray - -`fun asStringArray(): Array` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L335) \ No newline at end of file diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/data.md b/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/data.md deleted file mode 100644 index 06e9c6a..0000000 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/data.md +++ /dev/null @@ -1,8 +0,0 @@ -[0.3.0](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [data](.) - -# data - -`val data: Any` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L316) - -Array data. - diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/shape.md b/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/shape.md deleted file mode 100644 index 1e806c3..0000000 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/shape.md +++ /dev/null @@ -1,8 +0,0 @@ -[0.3.0](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [shape](.) - -# shape - -`val shape: IntArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L318) - -Array dimensions. - diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/to-string.md b/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/to-string.md deleted file mode 100644 index ac7f089..0000000 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/to-string.md +++ /dev/null @@ -1,5 +0,0 @@ -[0.3.0](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [toString](.) - -# toString - -`fun toString(): ` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L337) \ No newline at end of file diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npy-file/index.md b/docs/0.3.0/org.jetbrains.bio.npy/-npy-file/index.md deleted file mode 100644 index e8f7d69..0000000 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npy-file/index.md +++ /dev/null @@ -1,36 +0,0 @@ -[0.3.0](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyFile](.) - -# NpyFile - -`object NpyFile` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L35) - -A file in NPY format. - -Currently unsupported types: - -* unsigned integral types (treated as signed) -* bit field, -* complex, -* object, -* Unicode -* void* -* intersections aka types for structured arrays. - -See http://docs.scipy.org/doc/numpy-dev/neps/npy-format.html - -Example: - -``` kotlin -val values = intArrayOf(1, 2, 3, 4, 5, 6) -val path = Paths.get("sample.npy") -NpyFile.write(path, values, shape = intArrayOf(2, 3)) -println(NpyFile.read(path)) -// => NpyArray{data=[1, 2, 3, 4, 5, 6], shape=[2, 3]} -``` - -### Functions - -| Name | Summary | -|---|---| -| [read](read.md) | `fun read(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`): `[`NpyArray`](../-npy-array/index.md)
Reads an array in NPY format from a given path. | -| [write](write.md) | `fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: BooleanArray, shape: IntArray = intArrayOf(data.size)): Unit`
Writes an array in NPY format to a given path.`fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: ByteArray, shape: IntArray = intArrayOf(data.size)): Unit`
`fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: ShortArray, shape: IntArray = intArrayOf(data.size)): Unit`
`fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: IntArray, shape: IntArray = intArrayOf(data.size)): Unit`
`fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: LongArray, shape: IntArray = intArrayOf(data.size)): Unit`
`fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: FloatArray, shape: IntArray = intArrayOf(data.size)): Unit`
`fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: DoubleArray, shape: IntArray = intArrayOf(data.size)): Unit`
`fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: Array, shape: IntArray = intArrayOf(data.size)): Unit` | diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npy-file/write.md b/docs/0.3.0/org.jetbrains.bio.npy/-npy-file/write.md deleted file mode 100644 index 3a4ca77..0000000 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npy-file/write.md +++ /dev/null @@ -1,15 +0,0 @@ -[0.3.0](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyFile](index.md) / [write](.) - -# write - -`@JvmOverloads @JvmStatic fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: BooleanArray, shape: IntArray = intArrayOf(data.size)): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L207) - -Writes an array in NPY format to a given path. - -`@JvmOverloads @JvmStatic fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: ByteArray, shape: IntArray = intArrayOf(data.size)): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L213) -`@JvmOverloads @JvmStatic fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: ShortArray, shape: IntArray = intArrayOf(data.size)): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L219) -`@JvmOverloads @JvmStatic fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: IntArray, shape: IntArray = intArrayOf(data.size)): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L225) -`@JvmOverloads @JvmStatic fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: LongArray, shape: IntArray = intArrayOf(data.size)): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L231) -`@JvmOverloads @JvmStatic fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: FloatArray, shape: IntArray = intArrayOf(data.size)): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L237) -`@JvmOverloads @JvmStatic fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: DoubleArray, shape: IntArray = intArrayOf(data.size)): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L243) -`@JvmOverloads @JvmStatic fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: Array, shape: IntArray = intArrayOf(data.size)): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L249) \ No newline at end of file diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npz-entry/name.md b/docs/0.3.0/org.jetbrains.bio.npy/-npz-entry/name.md deleted file mode 100644 index 41e486e..0000000 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npz-entry/name.md +++ /dev/null @@ -1,5 +0,0 @@ -[0.3.0](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzEntry](index.md) / [name](.) - -# name - -`val name: String` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L180) \ No newline at end of file diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npz-entry/shape.md b/docs/0.3.0/org.jetbrains.bio.npy/-npz-entry/shape.md deleted file mode 100644 index 9bafd15..0000000 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npz-entry/shape.md +++ /dev/null @@ -1,5 +0,0 @@ -[0.3.0](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzEntry](index.md) / [shape](.) - -# shape - -`val shape: IntArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L180) \ No newline at end of file diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npz-entry/to-string.md b/docs/0.3.0/org.jetbrains.bio.npy/-npz-entry/to-string.md deleted file mode 100644 index 7025bc3..0000000 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npz-entry/to-string.md +++ /dev/null @@ -1,5 +0,0 @@ -[0.3.0](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzEntry](index.md) / [toString](.) - -# toString - -`fun toString(): String` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L181) \ No newline at end of file diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-writer/index.md b/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-writer/index.md deleted file mode 100644 index 5a0c98c..0000000 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-writer/index.md +++ /dev/null @@ -1,25 +0,0 @@ -[0.3.0](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Writer](.) - -# Writer - -`data class Writer : `[`Closeable`](http://docs.oracle.com/javase/6/docs/api/java/io/Closeable.html)`, `[`AutoCloseable`](http://docs.oracle.com/javase/6/docs/api/java/lang/AutoCloseable.html) [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L98) - -A writer for NPZ format. - -The implementation uses a temporary [ByteBuffer](http://docs.oracle.com/javase/6/docs/api/java/nio/ByteBuffer.html) to store the -serialized array prior to archiving. Thus each [write](write.md) call -requires N extra bytes of memory for an array of N bytes. - -### Properties - -| Name | Summary | -|---|---| -| [compressed](compressed.md) | `val compressed: Boolean` | -| [path](path.md) | `val path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html) | - -### Functions - -| Name | Summary | -|---|---| -| [close](close.md) | `fun close(): Unit` | -| [write](write.md) | `fun write(name: String, data: BooleanArray, shape: IntArray = intArrayOf(data.size)): Unit`
`fun write(name: String, data: ByteArray, shape: IntArray = intArrayOf(data.size)): Unit`
`fun write(name: String, data: ShortArray, shape: IntArray = intArrayOf(data.size)): Unit`
`fun write(name: String, data: IntArray, shape: IntArray = intArrayOf(data.size)): Unit`
`fun write(name: String, data: LongArray, shape: IntArray = intArrayOf(data.size)): Unit`
`fun write(name: String, data: FloatArray, shape: IntArray = intArrayOf(data.size)): Unit`
`fun write(name: String, data: DoubleArray, shape: IntArray = intArrayOf(data.size)): Unit`
`fun write(name: String, data: Array, shape: IntArray = intArrayOf(data.size)): Unit` | diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-writer/write.md b/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-writer/write.md deleted file mode 100644 index 6ff09e5..0000000 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-writer/write.md +++ /dev/null @@ -1,12 +0,0 @@ -[0.3.0](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Writer](index.md) / [write](.) - -# write - -`@JvmOverloads fun write(name: String, data: BooleanArray, shape: IntArray = intArrayOf(data.size)): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L105) -`@JvmOverloads fun write(name: String, data: ByteArray, shape: IntArray = intArrayOf(data.size)): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L110) -`@JvmOverloads fun write(name: String, data: ShortArray, shape: IntArray = intArrayOf(data.size)): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L115) -`@JvmOverloads fun write(name: String, data: IntArray, shape: IntArray = intArrayOf(data.size)): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L120) -`@JvmOverloads fun write(name: String, data: LongArray, shape: IntArray = intArrayOf(data.size)): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L125) -`@JvmOverloads fun write(name: String, data: FloatArray, shape: IntArray = intArrayOf(data.size)): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L130) -`@JvmOverloads fun write(name: String, data: DoubleArray, shape: IntArray = intArrayOf(data.size)): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L135) -`@JvmOverloads fun write(name: String, data: Array, shape: IntArray = intArrayOf(data.size)): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L140) \ No newline at end of file diff --git a/docs/0.3.0/alltypes/index.md b/docs/0.3.1/alltypes/index.md similarity index 100% rename from docs/0.3.0/alltypes/index.md rename to docs/0.3.1/alltypes/index.md diff --git a/docs/0.3.0/index.md b/docs/0.3.1/index.md similarity index 93% rename from docs/0.3.0/index.md rename to docs/0.3.1/index.md index bfdef6f..3bc4f34 100644 --- a/docs/0.3.0/index.md +++ b/docs/0.3.1/index.md @@ -1,4 +1,4 @@ -[0.3.0](.) +[0.3.1](.) ### Packages diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/-init-.md b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/-init-.md similarity index 67% rename from docs/0.3.0/org.jetbrains.bio.npy/-npy-array/-init-.md rename to docs/0.3.1/org.jetbrains.bio.npy/-npy-array/-init-.md index bd26b84..322b1e8 100644 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/-init-.md +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/-init-.md @@ -1,4 +1,4 @@ -[0.3.0](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [<init>](.) +[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [<init>](.) # <init> diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-boolean-array.md b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-boolean-array.md new file mode 100644 index 0000000..a420ab3 --- /dev/null +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-boolean-array.md @@ -0,0 +1,5 @@ +[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [asBooleanArray](.) + +# asBooleanArray + +`fun asBooleanArray(): BooleanArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L317) \ No newline at end of file diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-byte-array.md b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-byte-array.md new file mode 100644 index 0000000..fccd0de --- /dev/null +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-byte-array.md @@ -0,0 +1,5 @@ +[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [asByteArray](.) + +# asByteArray + +`fun asByteArray(): ByteArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L319) \ No newline at end of file diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-double-array.md b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-double-array.md new file mode 100644 index 0000000..3c6b30d --- /dev/null +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-double-array.md @@ -0,0 +1,5 @@ +[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [asDoubleArray](.) + +# asDoubleArray + +`fun asDoubleArray(): DoubleArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L329) \ No newline at end of file diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-float-array.md b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-float-array.md new file mode 100644 index 0000000..9531d11 --- /dev/null +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-float-array.md @@ -0,0 +1,5 @@ +[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [asFloatArray](.) + +# asFloatArray + +`fun asFloatArray(): FloatArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L327) \ No newline at end of file diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-int-array.md b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-int-array.md new file mode 100644 index 0000000..53ad53e --- /dev/null +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-int-array.md @@ -0,0 +1,5 @@ +[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [asIntArray](.) + +# asIntArray + +`fun asIntArray(): IntArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L323) \ No newline at end of file diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-long-array.md b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-long-array.md new file mode 100644 index 0000000..5aebb0a --- /dev/null +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-long-array.md @@ -0,0 +1,5 @@ +[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [asLongArray](.) + +# asLongArray + +`fun asLongArray(): LongArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L325) \ No newline at end of file diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-short-array.md b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-short-array.md new file mode 100644 index 0000000..2007d9b --- /dev/null +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-short-array.md @@ -0,0 +1,5 @@ +[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [asShortArray](.) + +# asShortArray + +`fun asShortArray(): ShortArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L321) \ No newline at end of file diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-string-array.md b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-string-array.md new file mode 100644 index 0000000..f968498 --- /dev/null +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-string-array.md @@ -0,0 +1,5 @@ +[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [asStringArray](.) + +# asStringArray + +`fun asStringArray(): Array` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L332) \ No newline at end of file diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/data.md b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/data.md new file mode 100644 index 0000000..941f61a --- /dev/null +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/data.md @@ -0,0 +1,8 @@ +[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [data](.) + +# data + +`val data: Any` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L313) + +Array data. + diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/index.md b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/index.md similarity index 84% rename from docs/0.3.0/org.jetbrains.bio.npy/-npy-array/index.md rename to docs/0.3.1/org.jetbrains.bio.npy/-npy-array/index.md index eb85cb4..e879cf3 100644 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npy-array/index.md +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/index.md @@ -1,8 +1,8 @@ -[0.3.0](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](.) +[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](.) # NpyArray -`class NpyArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L314) +`class NpyArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L311) A wrapper for NPY array data. @@ -31,4 +31,4 @@ A wrapper for NPY array data. | [asLongArray](as-long-array.md) | `fun asLongArray(): LongArray` | | [asShortArray](as-short-array.md) | `fun asShortArray(): ShortArray` | | [asStringArray](as-string-array.md) | `fun asStringArray(): Array` | -| [toString](to-string.md) | `fun toString(): ` | +| [toString](to-string.md) | `fun toString(): String` | diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/shape.md b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/shape.md new file mode 100644 index 0000000..e03965b --- /dev/null +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/shape.md @@ -0,0 +1,8 @@ +[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [shape](.) + +# shape + +`val shape: IntArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L315) + +Array dimensions. + diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/to-string.md b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/to-string.md new file mode 100644 index 0000000..c16664f --- /dev/null +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/to-string.md @@ -0,0 +1,5 @@ +[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [toString](.) + +# toString + +`fun toString(): String` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L334) \ No newline at end of file diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npy-file/index.md b/docs/0.3.1/org.jetbrains.bio.npy/-npy-file/index.md new file mode 100644 index 0000000..bc03ca3 --- /dev/null +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npy-file/index.md @@ -0,0 +1,36 @@ +[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyFile](.) + +# NpyFile + +`object NpyFile` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L31) + +A file in NPY format. + +Currently unsupported types: + +* unsigned integral types (treated as signed) +* bit field, +* complex, +* object, +* Unicode +* void* +* intersections aka types for structured arrays. + +See http://docs.scipy.org/doc/numpy-dev/neps/npy-format.html + +Example: + +``` kotlin +val values = intArrayOf(1, 2, 3, 4, 5, 6) +val path = Paths.get("sample.npy") +NpyFile.write(path, values, shape = intArrayOf(2, 3)) +println(NpyFile.read(path)) +// => NpyArray{data=[1, 2, 3, 4, 5, 6], shape=[2, 3]} +``` + +### Functions + +| Name | Summary | +|---|---| +| [read](read.md) | `fun read(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`): `[`NpyArray`](../-npy-array/index.md)
Reads an array in NPY format from a given path. | +| [write](write.md) | `fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: BooleanArray, shape: IntArray = intArrayOf(data.size)): Unit`
Writes an array in NPY format to a given path.`fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: ByteArray, shape: IntArray = intArrayOf(data.size)): Unit`
`fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: ShortArray, shape: IntArray = intArrayOf(data.size), order: `[`ByteOrder`](http://docs.oracle.com/javase/6/docs/api/java/nio/ByteOrder.html)` = ByteOrder.nativeOrder()): Unit`
`fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: IntArray, shape: IntArray = intArrayOf(data.size), order: `[`ByteOrder`](http://docs.oracle.com/javase/6/docs/api/java/nio/ByteOrder.html)` = ByteOrder.nativeOrder()): Unit`
`fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: LongArray, shape: IntArray = intArrayOf(data.size), order: `[`ByteOrder`](http://docs.oracle.com/javase/6/docs/api/java/nio/ByteOrder.html)` = ByteOrder.nativeOrder()): Unit`
`fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: FloatArray, shape: IntArray = intArrayOf(data.size), order: `[`ByteOrder`](http://docs.oracle.com/javase/6/docs/api/java/nio/ByteOrder.html)` = ByteOrder.nativeOrder()): Unit`
`fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: DoubleArray, shape: IntArray = intArrayOf(data.size), order: `[`ByteOrder`](http://docs.oracle.com/javase/6/docs/api/java/nio/ByteOrder.html)` = ByteOrder.nativeOrder()): Unit`
`fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: Array, shape: IntArray = intArrayOf(data.size)): Unit` | diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npy-file/read.md b/docs/0.3.1/org.jetbrains.bio.npy/-npy-file/read.md similarity index 76% rename from docs/0.3.0/org.jetbrains.bio.npy/-npy-file/read.md rename to docs/0.3.1/org.jetbrains.bio.npy/-npy-file/read.md index 8867fb9..ace23e2 100644 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npy-file/read.md +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npy-file/read.md @@ -1,8 +1,8 @@ -[0.3.0](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyFile](index.md) / [read](.) +[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyFile](index.md) / [read](.) # read -`@JvmStatic fun read(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`): `[`NpyArray`](../-npy-array/index.md) [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L165) +`@JvmStatic fun read(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`): `[`NpyArray`](../-npy-array/index.md) [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L151) Reads an array in NPY format from a given path. diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npy-file/write.md b/docs/0.3.1/org.jetbrains.bio.npy/-npy-file/write.md new file mode 100644 index 0000000..864cc8c --- /dev/null +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npy-file/write.md @@ -0,0 +1,15 @@ +[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyFile](index.md) / [write](.) + +# write + +`@JvmOverloads @JvmStatic fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: BooleanArray, shape: IntArray = intArrayOf(data.size)): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L193) + +Writes an array in NPY format to a given path. + +`@JvmOverloads @JvmStatic fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: ByteArray, shape: IntArray = intArrayOf(data.size)): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L199) +`@JvmOverloads @JvmStatic fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: ShortArray, shape: IntArray = intArrayOf(data.size), order: `[`ByteOrder`](http://docs.oracle.com/javase/6/docs/api/java/nio/ByteOrder.html)` = ByteOrder.nativeOrder()): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L205) +`@JvmOverloads @JvmStatic fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: IntArray, shape: IntArray = intArrayOf(data.size), order: `[`ByteOrder`](http://docs.oracle.com/javase/6/docs/api/java/nio/ByteOrder.html)` = ByteOrder.nativeOrder()): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L212) +`@JvmOverloads @JvmStatic fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: LongArray, shape: IntArray = intArrayOf(data.size), order: `[`ByteOrder`](http://docs.oracle.com/javase/6/docs/api/java/nio/ByteOrder.html)` = ByteOrder.nativeOrder()): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L219) +`@JvmOverloads @JvmStatic fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: FloatArray, shape: IntArray = intArrayOf(data.size), order: `[`ByteOrder`](http://docs.oracle.com/javase/6/docs/api/java/nio/ByteOrder.html)` = ByteOrder.nativeOrder()): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L226) +`@JvmOverloads @JvmStatic fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: DoubleArray, shape: IntArray = intArrayOf(data.size), order: `[`ByteOrder`](http://docs.oracle.com/javase/6/docs/api/java/nio/ByteOrder.html)` = ByteOrder.nativeOrder()): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L233) +`@JvmOverloads @JvmStatic fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: Array, shape: IntArray = intArrayOf(data.size)): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L240) \ No newline at end of file diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npz-entry/-init-.md b/docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/-init-.md similarity index 78% rename from docs/0.3.0/org.jetbrains.bio.npy/-npz-entry/-init-.md rename to docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/-init-.md index 4130609..f08345b 100644 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npz-entry/-init-.md +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/-init-.md @@ -1,4 +1,4 @@ -[0.3.0](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzEntry](index.md) / [<init>](.) +[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzEntry](index.md) / [<init>](.) # <init> diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npz-entry/index.md b/docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/index.md similarity index 84% rename from docs/0.3.0/org.jetbrains.bio.npy/-npz-entry/index.md rename to docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/index.md index e045a64..d193bd7 100644 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npz-entry/index.md +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/index.md @@ -1,8 +1,8 @@ -[0.3.0](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzEntry](.) +[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzEntry](.) # NpzEntry -`class NpzEntry` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L180) +`class NpzEntry` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L193) A stripped down NPY header for an array in NPZ. diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/name.md b/docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/name.md new file mode 100644 index 0000000..483ad0f --- /dev/null +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/name.md @@ -0,0 +1,5 @@ +[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzEntry](index.md) / [name](.) + +# name + +`val name: String` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L193) \ No newline at end of file diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/shape.md b/docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/shape.md new file mode 100644 index 0000000..640bbac --- /dev/null +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/shape.md @@ -0,0 +1,5 @@ +[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzEntry](index.md) / [shape](.) + +# shape + +`val shape: IntArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L193) \ No newline at end of file diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/to-string.md b/docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/to-string.md new file mode 100644 index 0000000..d679bd2 --- /dev/null +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/to-string.md @@ -0,0 +1,5 @@ +[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzEntry](index.md) / [toString](.) + +# toString + +`fun toString(): String` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L194) \ No newline at end of file diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npz-entry/type.md b/docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/type.md similarity index 54% rename from docs/0.3.0/org.jetbrains.bio.npy/-npz-entry/type.md rename to docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/type.md index 4e991c1..9add6b2 100644 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npz-entry/type.md +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/type.md @@ -1,5 +1,5 @@ -[0.3.0](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzEntry](index.md) / [type](.) +[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzEntry](index.md) / [type](.) # type -`val type: `[`Class`](http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html)`<*>` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L180) \ No newline at end of file +`val type: `[`Class`](http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html)`<*>` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L193) \ No newline at end of file diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-reader/close.md b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/close.md similarity index 52% rename from docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-reader/close.md rename to docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/close.md index e6a7879..de206f0 100644 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-reader/close.md +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/close.md @@ -1,5 +1,5 @@ -[0.3.0](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Reader](index.md) / [close](.) +[0.3.1](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Reader](index.md) / [close](.) # close -`fun close(): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L85) \ No newline at end of file +`fun close(): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L85) \ No newline at end of file diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-reader/get.md b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/get.md similarity index 71% rename from docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-reader/get.md rename to docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/get.md index dacb535..86f9bcf 100644 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-reader/get.md +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/get.md @@ -1,8 +1,8 @@ -[0.3.0](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Reader](index.md) / [get](.) +[0.3.1](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Reader](index.md) / [get](.) # get -`operator fun get(name: String): `[`NpyArray`](../../-npy-array/index.md) [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L71) +`operator fun get(name: String): `[`NpyArray`](../../-npy-array/index.md) [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L71) Returns an array for a given name. diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-reader/index.md b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/index.md similarity index 87% rename from docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-reader/index.md rename to docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/index.md index 7925165..fd5a0c0 100644 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-reader/index.md +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/index.md @@ -1,8 +1,8 @@ -[0.3.0](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Reader](.) +[0.3.1](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Reader](.) # Reader -`data class Reader : `[`Closeable`](http://docs.oracle.com/javase/6/docs/api/java/io/Closeable.html)`, `[`AutoCloseable`](http://docs.oracle.com/javase/6/docs/api/java/lang/AutoCloseable.html) [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L33) +`data class Reader : `[`Closeable`](http://docs.oracle.com/javase/6/docs/api/java/io/Closeable.html)`, `[`AutoCloseable`](http://docs.oracle.com/javase/6/docs/api/java/lang/AutoCloseable.html) [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L33) A reader for NPZ format. diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-reader/introspect.md b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/introspect.md similarity index 67% rename from docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-reader/introspect.md rename to docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/introspect.md index 734d40b..8168275 100644 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-reader/introspect.md +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/introspect.md @@ -1,8 +1,8 @@ -[0.3.0](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Reader](index.md) / [introspect](.) +[0.3.1](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Reader](index.md) / [introspect](.) # introspect -`fun introspect(): ` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L42) +`fun introspect(): ` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L42) Returns a mapping from array names to the corresponding scalar types in Java. diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-reader/path.md b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/path.md similarity index 61% rename from docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-reader/path.md rename to docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/path.md index 03662aa..7d04a4c 100644 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-reader/path.md +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/path.md @@ -1,5 +1,5 @@ -[0.3.0](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Reader](index.md) / [path](.) +[0.3.1](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Reader](index.md) / [path](.) # path -`val path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html) [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L33) \ No newline at end of file +`val path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html) [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L33) \ No newline at end of file diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-writer/close.md b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/close.md similarity index 50% rename from docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-writer/close.md rename to docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/close.md index df0fdef..f689bed 100644 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-writer/close.md +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/close.md @@ -1,5 +1,5 @@ -[0.3.0](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Writer](index.md) / [close](.) +[0.3.1](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Writer](index.md) / [close](.) # close -`fun close(): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L170) \ No newline at end of file +`fun close(): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L183) \ No newline at end of file diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-writer/compressed.md b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/compressed.md similarity index 55% rename from docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-writer/compressed.md rename to docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/compressed.md index d660e83..e791f06 100644 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-writer/compressed.md +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/compressed.md @@ -1,5 +1,5 @@ -[0.3.0](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Writer](index.md) / [compressed](.) +[0.3.1](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Writer](index.md) / [compressed](.) # compressed -`val compressed: Boolean` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L98) \ No newline at end of file +`val compressed: Boolean` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L98) \ No newline at end of file diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/index.md b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/index.md new file mode 100644 index 0000000..ff5ff35 --- /dev/null +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/index.md @@ -0,0 +1,25 @@ +[0.3.1](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Writer](.) + +# Writer + +`data class Writer : `[`Closeable`](http://docs.oracle.com/javase/6/docs/api/java/io/Closeable.html)`, `[`AutoCloseable`](http://docs.oracle.com/javase/6/docs/api/java/lang/AutoCloseable.html) [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L98) + +A writer for NPZ format. + +The implementation uses a temporary [ByteBuffer](http://docs.oracle.com/javase/6/docs/api/java/nio/ByteBuffer.html) to store the +serialized array prior to archiving. Thus each [write](write.md) call +requires N extra bytes of memory for an array of N bytes. + +### Properties + +| Name | Summary | +|---|---| +| [compressed](compressed.md) | `val compressed: Boolean` | +| [path](path.md) | `val path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html) | + +### Functions + +| Name | Summary | +|---|---| +| [close](close.md) | `fun close(): Unit` | +| [write](write.md) | `fun write(name: String, data: BooleanArray, shape: IntArray = intArrayOf(data.size)): Unit`
`fun write(name: String, data: ByteArray, shape: IntArray = intArrayOf(data.size)): Unit`
`fun write(name: String, data: ShortArray, shape: IntArray = intArrayOf(data.size), order: `[`ByteOrder`](http://docs.oracle.com/javase/6/docs/api/java/nio/ByteOrder.html)` = ByteOrder.nativeOrder()): Unit`
`fun write(name: String, data: IntArray, shape: IntArray = intArrayOf(data.size), order: `[`ByteOrder`](http://docs.oracle.com/javase/6/docs/api/java/nio/ByteOrder.html)` = ByteOrder.nativeOrder()): Unit`
`fun write(name: String, data: LongArray, shape: IntArray = intArrayOf(data.size), order: `[`ByteOrder`](http://docs.oracle.com/javase/6/docs/api/java/nio/ByteOrder.html)` = ByteOrder.nativeOrder()): Unit`
`fun write(name: String, data: FloatArray, shape: IntArray = intArrayOf(data.size), order: `[`ByteOrder`](http://docs.oracle.com/javase/6/docs/api/java/nio/ByteOrder.html)` = ByteOrder.nativeOrder()): Unit`
`fun write(name: String, data: DoubleArray, shape: IntArray = intArrayOf(data.size), order: `[`ByteOrder`](http://docs.oracle.com/javase/6/docs/api/java/nio/ByteOrder.html)` = ByteOrder.nativeOrder()): Unit`
`fun write(name: String, data: Array, shape: IntArray = intArrayOf(data.size)): Unit` | diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-writer/path.md b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/path.md similarity index 61% rename from docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-writer/path.md rename to docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/path.md index 1ecdc1e..1221b4d 100644 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/-writer/path.md +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/path.md @@ -1,5 +1,5 @@ -[0.3.0](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Writer](index.md) / [path](.) +[0.3.1](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Writer](index.md) / [path](.) # path -`val path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html) [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L98) \ No newline at end of file +`val path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html) [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L98) \ No newline at end of file diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/write.md b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/write.md new file mode 100644 index 0000000..7837b3c --- /dev/null +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/write.md @@ -0,0 +1,12 @@ +[0.3.1](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Writer](index.md) / [write](.) + +# write + +`@JvmOverloads fun write(name: String, data: BooleanArray, shape: IntArray = intArrayOf(data.size)): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L105) +`@JvmOverloads fun write(name: String, data: ByteArray, shape: IntArray = intArrayOf(data.size)): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L110) +`@JvmOverloads fun write(name: String, data: ShortArray, shape: IntArray = intArrayOf(data.size), order: `[`ByteOrder`](http://docs.oracle.com/javase/6/docs/api/java/nio/ByteOrder.html)` = ByteOrder.nativeOrder()): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L115) +`@JvmOverloads fun write(name: String, data: IntArray, shape: IntArray = intArrayOf(data.size), order: `[`ByteOrder`](http://docs.oracle.com/javase/6/docs/api/java/nio/ByteOrder.html)` = ByteOrder.nativeOrder()): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L121) +`@JvmOverloads fun write(name: String, data: LongArray, shape: IntArray = intArrayOf(data.size), order: `[`ByteOrder`](http://docs.oracle.com/javase/6/docs/api/java/nio/ByteOrder.html)` = ByteOrder.nativeOrder()): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L127) +`@JvmOverloads fun write(name: String, data: FloatArray, shape: IntArray = intArrayOf(data.size), order: `[`ByteOrder`](http://docs.oracle.com/javase/6/docs/api/java/nio/ByteOrder.html)` = ByteOrder.nativeOrder()): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L133) +`@JvmOverloads fun write(name: String, data: DoubleArray, shape: IntArray = intArrayOf(data.size), order: `[`ByteOrder`](http://docs.oracle.com/javase/6/docs/api/java/nio/ByteOrder.html)` = ByteOrder.nativeOrder()): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L139) +`@JvmOverloads fun write(name: String, data: Array, shape: IntArray = intArrayOf(data.size)): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L145) \ No newline at end of file diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/index.md b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/index.md similarity index 94% rename from docs/0.3.0/org.jetbrains.bio.npy/-npz-file/index.md rename to docs/0.3.1/org.jetbrains.bio.npy/-npz-file/index.md index dc068c5..49a0a40 100644 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/index.md +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/index.md @@ -1,8 +1,8 @@ -[0.3.0](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzFile](.) +[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzFile](.) # NpzFile -`object NpzFile` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L27) +`object NpzFile` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L27) A ZIP file where each individual file is in NPY format. diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/read.md b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/read.md similarity index 73% rename from docs/0.3.0/org.jetbrains.bio.npy/-npz-file/read.md rename to docs/0.3.1/org.jetbrains.bio.npy/-npz-file/read.md index c0063c0..24d1345 100644 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/read.md +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/read.md @@ -1,8 +1,8 @@ -[0.3.0](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzFile](index.md) / [read](.) +[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzFile](index.md) / [read](.) # read -`@JvmStatic fun read(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`): `[`Reader`](-reader/index.md) [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L89) +`@JvmStatic fun read(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`): `[`Reader`](-reader/index.md) [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L89) Opens an NPZ file at [path](read.md#org.jetbrains.bio.npy.NpzFile$read(java.nio.file.Path)/path) for reading. diff --git a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/write.md b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/write.md similarity index 70% rename from docs/0.3.0/org.jetbrains.bio.npy/-npz-file/write.md rename to docs/0.3.1/org.jetbrains.bio.npy/-npz-file/write.md index 18995f2..98397b2 100644 --- a/docs/0.3.0/org.jetbrains.bio.npy/-npz-file/write.md +++ b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/write.md @@ -1,8 +1,8 @@ -[0.3.0](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzFile](index.md) / [write](.) +[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzFile](index.md) / [write](.) # write -`@JvmStatic fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, compressed: Boolean = false): `[`Writer`](-writer/index.md) [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L174) +`@JvmStatic fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, compressed: Boolean = false): `[`Writer`](-writer/index.md) [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L187) Opens an NPZ file at [path](write.md#org.jetbrains.bio.npy.NpzFile$write(java.nio.file.Path, kotlin.Boolean)/path) for writing. diff --git a/docs/0.3.0/org.jetbrains.bio.npy/index.md b/docs/0.3.1/org.jetbrains.bio.npy/index.md similarity index 90% rename from docs/0.3.0/org.jetbrains.bio.npy/index.md rename to docs/0.3.1/org.jetbrains.bio.npy/index.md index 348732b..22df956 100644 --- a/docs/0.3.0/org.jetbrains.bio.npy/index.md +++ b/docs/0.3.1/org.jetbrains.bio.npy/index.md @@ -1,4 +1,4 @@ -[0.3.0](../index.md) / [org.jetbrains.bio.npy](.) +[0.3.1](../index.md) / [org.jetbrains.bio.npy](.) ## Package org.jetbrains.bio.npy diff --git a/gradle.properties b/gradle.properties index 7a7e30c..81a6c99 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,2 +1,2 @@ groupId=org.jetbrains.bio -version=0.3.0 +version=0.3.1