diff --git a/CHANGES b/CHANGES index c20380b..b7fa740 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.2 ------------- +Released on September 23rd, 2016 + - Fixed reading large (> 2G) NPY and NPZ files. - Ensured the produced NPY file has no trailing gibberish. - Changed `NpyFile.write` to automatically choose the appropriate diff --git a/README.md b/README.md index f7c2079..67ccf66 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ repositories { } dependencies { - compile 'org.jetbrains.bio:npy:0.3.1' + compile 'org.jetbrains.bio:npy:0.3.2' } ``` 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 deleted file mode 100644 index a420ab3..0000000 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-boolean-array.md +++ /dev/null @@ -1,5 +0,0 @@ -[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 deleted file mode 100644 index fccd0de..0000000 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-byte-array.md +++ /dev/null @@ -1,5 +0,0 @@ -[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 deleted file mode 100644 index 3c6b30d..0000000 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-double-array.md +++ /dev/null @@ -1,5 +0,0 @@ -[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 deleted file mode 100644 index 9531d11..0000000 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-float-array.md +++ /dev/null @@ -1,5 +0,0 @@ -[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 deleted file mode 100644 index 53ad53e..0000000 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-int-array.md +++ /dev/null @@ -1,5 +0,0 @@ -[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 deleted file mode 100644 index 5aebb0a..0000000 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-long-array.md +++ /dev/null @@ -1,5 +0,0 @@ -[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 deleted file mode 100644 index 2007d9b..0000000 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-short-array.md +++ /dev/null @@ -1,5 +0,0 @@ -[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 deleted file mode 100644 index f968498..0000000 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/as-string-array.md +++ /dev/null @@ -1,5 +0,0 @@ -[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 deleted file mode 100644 index 941f61a..0000000 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/data.md +++ /dev/null @@ -1,8 +0,0 @@ -[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.1/org.jetbrains.bio.npy/-npy-array/shape.md b/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/shape.md deleted file mode 100644 index e03965b..0000000 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/shape.md +++ /dev/null @@ -1,8 +0,0 @@ -[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 deleted file mode 100644 index c16664f..0000000 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/to-string.md +++ /dev/null @@ -1,5 +0,0 @@ -[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/-npz-entry/name.md b/docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/name.md deleted file mode 100644 index 483ad0f..0000000 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/name.md +++ /dev/null @@ -1,5 +0,0 @@ -[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 deleted file mode 100644 index 640bbac..0000000 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/shape.md +++ /dev/null @@ -1,5 +0,0 @@ -[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 deleted file mode 100644 index d679bd2..0000000 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/to-string.md +++ /dev/null @@ -1,5 +0,0 @@ -[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.1/org.jetbrains.bio.npy/-npz-file/-reader/get.md b/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/get.md deleted file mode 100644 index 86f9bcf..0000000 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/get.md +++ /dev/null @@ -1,11 +0,0 @@ -[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.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L71) - -Returns an array for a given name. - -The caller is responsible for casting the resulting array to an -appropriate type. - diff --git a/docs/0.3.1/alltypes/index.md b/docs/0.3.2/alltypes/index.md similarity index 100% rename from docs/0.3.1/alltypes/index.md rename to docs/0.3.2/alltypes/index.md diff --git a/docs/0.3.1/index.md b/docs/0.3.2/index.md similarity index 93% rename from docs/0.3.1/index.md rename to docs/0.3.2/index.md index 3bc4f34..245bd34 100644 --- a/docs/0.3.1/index.md +++ b/docs/0.3.2/index.md @@ -1,4 +1,4 @@ -[0.3.1](.) +[0.3.2](.) ### Packages diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/-init-.md b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/-init-.md similarity index 67% rename from docs/0.3.1/org.jetbrains.bio.npy/-npy-array/-init-.md rename to docs/0.3.2/org.jetbrains.bio.npy/-npy-array/-init-.md index 322b1e8..98f06f0 100644 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/-init-.md +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/-init-.md @@ -1,4 +1,4 @@ -[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [<init>](.) +[0.3.2](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](index.md) / [<init>](.) # <init> diff --git a/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/as-boolean-array.md b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/as-boolean-array.md new file mode 100644 index 0000000..409b204 --- /dev/null +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/as-boolean-array.md @@ -0,0 +1,5 @@ +[0.3.2](../../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.2/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L345) \ No newline at end of file diff --git a/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/as-byte-array.md b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/as-byte-array.md new file mode 100644 index 0000000..9cde03d --- /dev/null +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/as-byte-array.md @@ -0,0 +1,5 @@ +[0.3.2](../../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.2/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L347) \ No newline at end of file diff --git a/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/as-double-array.md b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/as-double-array.md new file mode 100644 index 0000000..d2cefc0 --- /dev/null +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/as-double-array.md @@ -0,0 +1,5 @@ +[0.3.2](../../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.2/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L357) \ No newline at end of file diff --git a/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/as-float-array.md b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/as-float-array.md new file mode 100644 index 0000000..eaa9d2f --- /dev/null +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/as-float-array.md @@ -0,0 +1,5 @@ +[0.3.2](../../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.2/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L355) \ No newline at end of file diff --git a/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/as-int-array.md b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/as-int-array.md new file mode 100644 index 0000000..5d5638d --- /dev/null +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/as-int-array.md @@ -0,0 +1,5 @@ +[0.3.2](../../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.2/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L351) \ No newline at end of file diff --git a/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/as-long-array.md b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/as-long-array.md new file mode 100644 index 0000000..fff73c6 --- /dev/null +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/as-long-array.md @@ -0,0 +1,5 @@ +[0.3.2](../../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.2/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L353) \ No newline at end of file diff --git a/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/as-short-array.md b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/as-short-array.md new file mode 100644 index 0000000..668352a --- /dev/null +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/as-short-array.md @@ -0,0 +1,5 @@ +[0.3.2](../../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.2/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L349) \ No newline at end of file diff --git a/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/as-string-array.md b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/as-string-array.md new file mode 100644 index 0000000..112339b --- /dev/null +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/as-string-array.md @@ -0,0 +1,5 @@ +[0.3.2](../../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.2/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L360) \ No newline at end of file diff --git a/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/data.md b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/data.md new file mode 100644 index 0000000..65f43e5 --- /dev/null +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/data.md @@ -0,0 +1,8 @@ +[0.3.2](../../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.2/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L341) + +Array data. + diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/index.md b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/index.md similarity index 89% rename from docs/0.3.1/org.jetbrains.bio.npy/-npy-array/index.md rename to docs/0.3.2/org.jetbrains.bio.npy/-npy-array/index.md index e879cf3..7870fb3 100644 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npy-array/index.md +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/index.md @@ -1,8 +1,8 @@ -[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](.) +[0.3.2](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyArray](.) # NpyArray -`class NpyArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L311) +`class NpyArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.2/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L339) A wrapper for NPY array data. diff --git a/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/shape.md b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/shape.md new file mode 100644 index 0000000..cc1a145 --- /dev/null +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/shape.md @@ -0,0 +1,8 @@ +[0.3.2](../../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.2/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L343) + +Array dimensions. + diff --git a/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/to-string.md b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/to-string.md new file mode 100644 index 0000000..c4af768 --- /dev/null +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npy-array/to-string.md @@ -0,0 +1,5 @@ +[0.3.2](../../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.2/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L362) \ 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.2/org.jetbrains.bio.npy/-npy-file/index.md similarity index 89% rename from docs/0.3.1/org.jetbrains.bio.npy/-npy-file/index.md rename to docs/0.3.2/org.jetbrains.bio.npy/-npy-file/index.md index bc03ca3..a0a3e91 100644 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npy-file/index.md +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npy-file/index.md @@ -1,8 +1,8 @@ -[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyFile](.) +[0.3.2](../../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) +`object NpyFile` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.2/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L32) A file in NPY format. @@ -32,5 +32,5 @@ println(NpyFile.read(path)) | 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. | +| [read](read.md) | `fun read(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, step: Int = Int.MAX_VALUE): `[`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.1/org.jetbrains.bio.npy/-npy-file/read.md b/docs/0.3.2/org.jetbrains.bio.npy/-npy-file/read.md similarity index 50% rename from docs/0.3.1/org.jetbrains.bio.npy/-npy-file/read.md rename to docs/0.3.2/org.jetbrains.bio.npy/-npy-file/read.md index ace23e2..083925f 100644 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npy-file/read.md +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npy-file/read.md @@ -1,8 +1,8 @@ -[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyFile](index.md) / [read](.) +[0.3.2](../../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.1/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L151) +`@JvmStatic fun read(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, step: Int = Int.MAX_VALUE): `[`NpyArray`](../-npy-array/index.md) [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.2/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L158) 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.2/org.jetbrains.bio.npy/-npy-file/write.md similarity index 72% rename from docs/0.3.1/org.jetbrains.bio.npy/-npy-file/write.md rename to docs/0.3.2/org.jetbrains.bio.npy/-npy-file/write.md index 864cc8c..549ba2e 100644 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npy-file/write.md +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npy-file/write.md @@ -1,15 +1,15 @@ -[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpyFile](index.md) / [write](.) +[0.3.2](../../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) +`@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.2/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L219) 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 +`@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.2/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: 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.2/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: 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.2/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L238) +`@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.2/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L245) +`@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.2/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L252) +`@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.2/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L259) +`@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.2/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L266) \ No newline at end of file diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/-init-.md b/docs/0.3.2/org.jetbrains.bio.npy/-npz-entry/-init-.md similarity index 78% rename from docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/-init-.md rename to docs/0.3.2/org.jetbrains.bio.npy/-npz-entry/-init-.md index f08345b..90d3da1 100644 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/-init-.md +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npz-entry/-init-.md @@ -1,4 +1,4 @@ -[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzEntry](index.md) / [<init>](.) +[0.3.2](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzEntry](index.md) / [<init>](.) # <init> diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/index.md b/docs/0.3.2/org.jetbrains.bio.npy/-npz-entry/index.md similarity index 84% rename from docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/index.md rename to docs/0.3.2/org.jetbrains.bio.npy/-npz-entry/index.md index d193bd7..a3e83f0 100644 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/index.md +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npz-entry/index.md @@ -1,8 +1,8 @@ -[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzEntry](.) +[0.3.2](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzEntry](.) # NpzEntry -`class NpzEntry` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L193) +`class NpzEntry` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.2/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L208) A stripped down NPY header for an array in NPZ. diff --git a/docs/0.3.2/org.jetbrains.bio.npy/-npz-entry/name.md b/docs/0.3.2/org.jetbrains.bio.npy/-npz-entry/name.md new file mode 100644 index 0000000..672e30a --- /dev/null +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npz-entry/name.md @@ -0,0 +1,5 @@ +[0.3.2](../../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.2/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L208) \ No newline at end of file diff --git a/docs/0.3.2/org.jetbrains.bio.npy/-npz-entry/shape.md b/docs/0.3.2/org.jetbrains.bio.npy/-npz-entry/shape.md new file mode 100644 index 0000000..e08b502 --- /dev/null +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npz-entry/shape.md @@ -0,0 +1,5 @@ +[0.3.2](../../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.2/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L208) \ No newline at end of file diff --git a/docs/0.3.2/org.jetbrains.bio.npy/-npz-entry/to-string.md b/docs/0.3.2/org.jetbrains.bio.npy/-npz-entry/to-string.md new file mode 100644 index 0000000..c3f63c4 --- /dev/null +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npz-entry/to-string.md @@ -0,0 +1,5 @@ +[0.3.2](../../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.2/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L209) \ No newline at end of file diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/type.md b/docs/0.3.2/org.jetbrains.bio.npy/-npz-entry/type.md similarity index 54% rename from docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/type.md rename to docs/0.3.2/org.jetbrains.bio.npy/-npz-entry/type.md index 9add6b2..b8e948d 100644 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npz-entry/type.md +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npz-entry/type.md @@ -1,5 +1,5 @@ -[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzEntry](index.md) / [type](.) +[0.3.2](../../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.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L193) \ 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.2/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L208) \ No newline at end of file diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/close.md b/docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-reader/close.md similarity index 50% rename from docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/close.md rename to docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-reader/close.md index de206f0..78b8a12 100644 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/close.md +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-reader/close.md @@ -1,5 +1,5 @@ -[0.3.1](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Reader](index.md) / [close](.) +[0.3.2](../../../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.1/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.2/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L101) \ No newline at end of file diff --git a/docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-reader/get.md b/docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-reader/get.md new file mode 100644 index 0000000..10f95ed --- /dev/null +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-reader/get.md @@ -0,0 +1,18 @@ +[0.3.2](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Reader](index.md) / [get](.) + +# get + +`operator fun get(name: String, step: Int = 1 shl 18): `[`NpyArray`](../../-npy-array/index.md) [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.2/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L76) + +Returns an array for a given name. + +The caller is responsible for casting the resulting array to an +appropriate type. + +### Parameters + +`name` - array name. + +`step` - amount of bytes to use for the temporary buffer, when +reading the entry. Defaults to 1 << 18 to mimic NumPy +behaviour. \ No newline at end of file diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/index.md b/docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-reader/index.md similarity index 72% rename from docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/index.md rename to docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-reader/index.md index fd5a0c0..f488b25 100644 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/index.md +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-reader/index.md @@ -1,8 +1,8 @@ -[0.3.1](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Reader](.) +[0.3.2](../../../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.1/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.2/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L33) A reader for NPZ format. @@ -20,6 +20,6 @@ A reader for NPZ format. | Name | Summary | |---|---| | [close](close.md) | `fun close(): Unit` | -| [get](get.md) | `operator fun get(name: String): `[`NpyArray`](../../-npy-array/index.md)
Returns an array for a given name. | +| [get](get.md) | `operator fun get(name: String, step: Int = 1 shl 18): `[`NpyArray`](../../-npy-array/index.md)
Returns an array for a given name. | | [introspect](introspect.md) | `fun introspect(): `
Returns a mapping from array names to the corresponding scalar types in Java. | diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/introspect.md b/docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-reader/introspect.md similarity index 67% rename from docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/introspect.md rename to docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-reader/introspect.md index 8168275..c41fff8 100644 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/introspect.md +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-reader/introspect.md @@ -1,8 +1,8 @@ -[0.3.1](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Reader](index.md) / [introspect](.) +[0.3.2](../../../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.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L42) +`fun introspect(): ` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.2/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.1/org.jetbrains.bio.npy/-npz-file/-reader/path.md b/docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-reader/path.md similarity index 61% rename from docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/path.md rename to docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-reader/path.md index 7d04a4c..7e935e8 100644 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-reader/path.md +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-reader/path.md @@ -1,5 +1,5 @@ -[0.3.1](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Reader](index.md) / [path](.) +[0.3.2](../../../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.1/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.2/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L33) \ No newline at end of file diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/close.md b/docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-writer/close.md similarity index 50% rename from docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/close.md rename to docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-writer/close.md index f689bed..041ef34 100644 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/close.md +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-writer/close.md @@ -1,5 +1,5 @@ -[0.3.1](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Writer](index.md) / [close](.) +[0.3.2](../../../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.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L183) \ No newline at end of file +`fun close(): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.2/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L198) \ No newline at end of file diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/compressed.md b/docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-writer/compressed.md similarity index 51% rename from docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/compressed.md rename to docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-writer/compressed.md index e791f06..ab1da3f 100644 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/compressed.md +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-writer/compressed.md @@ -1,5 +1,5 @@ -[0.3.1](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Writer](index.md) / [compressed](.) +[0.3.2](../../../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.1/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.2/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L114) \ 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.2/org.jetbrains.bio.npy/-npz-file/-writer/index.md similarity index 92% rename from docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/index.md rename to docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-writer/index.md index ff5ff35..0791c1d 100644 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/index.md +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-writer/index.md @@ -1,8 +1,8 @@ -[0.3.1](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Writer](.) +[0.3.2](../../../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) +`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.2/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L114) A writer for NPZ format. diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/path.md b/docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-writer/path.md similarity index 59% rename from docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/path.md rename to docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-writer/path.md index 1221b4d..7abfe1d 100644 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/path.md +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-writer/path.md @@ -1,5 +1,5 @@ -[0.3.1](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Writer](index.md) / [path](.) +[0.3.2](../../../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.1/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.2/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L114) \ 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.2/org.jetbrains.bio.npy/-npz-file/-writer/write.md similarity index 70% rename from docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/write.md rename to docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-writer/write.md index 7837b3c..85023ad 100644 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/-writer/write.md +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npz-file/-writer/write.md @@ -1,12 +1,12 @@ -[0.3.1](../../../index.md) / [org.jetbrains.bio.npy](../../index.md) / [NpzFile](../index.md) / [Writer](index.md) / [write](.) +[0.3.2](../../../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 +`@JvmOverloads fun write(name: String, data: BooleanArray, shape: IntArray = intArrayOf(data.size)): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.2/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L121) +`@JvmOverloads fun write(name: String, data: ByteArray, shape: IntArray = intArrayOf(data.size)): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.2/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L126) +`@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.2/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L131) +`@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.2/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L137) +`@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.2/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L143) +`@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.2/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L149) +`@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.2/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L155) +`@JvmOverloads fun write(name: String, data: Array, shape: IntArray = intArrayOf(data.size)): Unit` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.2/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L161) \ No newline at end of file diff --git a/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/index.md b/docs/0.3.2/org.jetbrains.bio.npy/-npz-file/index.md similarity index 94% rename from docs/0.3.1/org.jetbrains.bio.npy/-npz-file/index.md rename to docs/0.3.2/org.jetbrains.bio.npy/-npz-file/index.md index 49a0a40..c23887e 100644 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/index.md +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npz-file/index.md @@ -1,8 +1,8 @@ -[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzFile](.) +[0.3.2](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzFile](.) # NpzFile -`object NpzFile` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L27) +`object NpzFile` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.2/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.1/org.jetbrains.bio.npy/-npz-file/read.md b/docs/0.3.2/org.jetbrains.bio.npy/-npz-file/read.md similarity index 73% rename from docs/0.3.1/org.jetbrains.bio.npy/-npz-file/read.md rename to docs/0.3.2/org.jetbrains.bio.npy/-npz-file/read.md index 24d1345..f365efe 100644 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/read.md +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npz-file/read.md @@ -1,8 +1,8 @@ -[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzFile](index.md) / [read](.) +[0.3.2](../../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.1/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.2/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L105) 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.1/org.jetbrains.bio.npy/-npz-file/write.md b/docs/0.3.2/org.jetbrains.bio.npy/-npz-file/write.md similarity index 70% rename from docs/0.3.1/org.jetbrains.bio.npy/-npz-file/write.md rename to docs/0.3.2/org.jetbrains.bio.npy/-npz-file/write.md index 98397b2..e4b8da7 100644 --- a/docs/0.3.1/org.jetbrains.bio.npy/-npz-file/write.md +++ b/docs/0.3.2/org.jetbrains.bio.npy/-npz-file/write.md @@ -1,8 +1,8 @@ -[0.3.1](../../index.md) / [org.jetbrains.bio.npy](../index.md) / [NpzFile](index.md) / [write](.) +[0.3.2](../../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.1/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L187) +`@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.2/src/main/kotlin/org/jetbrains/bio/npy/Npz.kt#L202) 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.1/org.jetbrains.bio.npy/index.md b/docs/0.3.2/org.jetbrains.bio.npy/index.md similarity index 90% rename from docs/0.3.1/org.jetbrains.bio.npy/index.md rename to docs/0.3.2/org.jetbrains.bio.npy/index.md index 22df956..32df0fb 100644 --- a/docs/0.3.1/org.jetbrains.bio.npy/index.md +++ b/docs/0.3.2/org.jetbrains.bio.npy/index.md @@ -1,4 +1,4 @@ -[0.3.1](../index.md) / [org.jetbrains.bio.npy](.) +[0.3.2](../index.md) / [org.jetbrains.bio.npy](.) ## Package org.jetbrains.bio.npy diff --git a/src/main/kotlin/org/jetbrains/bio/npy/ChunkerMerger.kt b/src/main/kotlin/org/jetbrains/bio/npy/ChunkerMerger.kt index 5cde80a..decfe70 100644 --- a/src/main/kotlin/org/jetbrains/bio/npy/ChunkerMerger.kt +++ b/src/main/kotlin/org/jetbrains/bio/npy/ChunkerMerger.kt @@ -141,12 +141,12 @@ internal class StringArrayChunker(data: Array) : /** * A chunked initializer for primitive array types. * - * JVM does not allow mapping files larger that `Int.MAX_SIZE` bytes, - * which is unfortunate because arrays can easily overcome that limit, - * think e.g. a [DoubleArray] of size `Int.MAX_SIZE / 2`. Therefore, - * it is not always possible to initialize an array by simply mapping - * a file and doing the usual [ByteBuffer] magic. This class aims to - * close the gap by allowing to populate an array in multiple takes. + * JVM does not allow mapping files larger that `Int.MAX_SIZE` bytes. + * As a result, one cannot simply read a primitive array from a memory + * mapped file via the usual [ByteBuffer] magic. + * + * This class allows to incrementally initialize an array from multiple + * buffers. * * @since 0.3.2 */