Skip to content

Commit

Permalink
Here comes 0.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
superbobry committed Sep 20, 2016
1 parent cd705ce commit 861958f
Show file tree
Hide file tree
Showing 20 changed files with 28 additions and 62 deletions.
2 changes: 2 additions & 0 deletions CHANGES
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Here you can see the full list of changes between each npy release.
Version 0.3.0
-------------

Released on September 20th, 2016

- Added support for reading and writing arbitrary-dimensional arrays.

Version 0.2.1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

# asBooleanArray

`fun asBooleanArray(): BooleanArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L322)
`fun asBooleanArray(): BooleanArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L320)
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

# asByteArray

`fun asByteArray(): ByteArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L324)
`fun asByteArray(): ByteArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L322)
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

# asDoubleArray

`fun asDoubleArray(): DoubleArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L334)
`fun asDoubleArray(): DoubleArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L332)
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

# asFloatArray

`fun asFloatArray(): FloatArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L332)
`fun asFloatArray(): FloatArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L330)
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

# asIntArray

`fun asIntArray(): IntArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L328)
`fun asIntArray(): IntArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L326)
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

# asLongArray

`fun asLongArray(): LongArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L330)
`fun asLongArray(): LongArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L328)
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

# asShortArray

`fun asShortArray(): ShortArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L326)
`fun asShortArray(): ShortArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L324)
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

# asStringArray

`fun asStringArray(): Array<String>` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L337)
`fun asStringArray(): Array<String>` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L335)
2 changes: 1 addition & 1 deletion docs/0.3.0/org.jetbrains.bio.npy/-npy-array/data.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# data

`val data: Any` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L318)
`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.

2 changes: 1 addition & 1 deletion docs/0.3.0/org.jetbrains.bio.npy/-npy-array/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# NpyArray

`class NpyArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L316)
`class NpyArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L314)

A wrapper for NPY array data.

Expand Down
2 changes: 1 addition & 1 deletion docs/0.3.0/org.jetbrains.bio.npy/-npy-array/shape.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# shape

`val shape: IntArray` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L320)
`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.

2 changes: 1 addition & 1 deletion docs/0.3.0/org.jetbrains.bio.npy/-npy-array/to-string.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

# toString

`fun toString(): <ERROR CLASS>` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L339)
`fun toString(): <ERROR CLASS>` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L337)
30 changes: 0 additions & 30 deletions docs/0.3.0/org.jetbrains.bio.npy/-npy-file/-init-.md

This file was deleted.

10 changes: 2 additions & 8 deletions docs/0.3.0/org.jetbrains.bio.npy/-npy-file/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# NpyFile

`class NpyFile` [(source)](https://github.com/JetBrains-Research/npy/blob/0.3.0/src/main/kotlin/org/jetbrains/bio/npy/Npy.kt#L35)
`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.

Expand All @@ -28,13 +28,7 @@ println(NpyFile.read(path))
// =&gt; NpyArray{data=[1, 2, 3, 4, 5, 6], shape=[2, 3]}
```

### Constructors

| Name | Summary |
|---|---|
| [&lt;init&gt;](-init-.md) | `NpyFile()`<br>A file in NPY format. |

### Companion Object Functions
### Functions

| Name | Summary |
|---|---|
Expand Down
2 changes: 1 addition & 1 deletion docs/0.3.0/org.jetbrains.bio.npy/-npy-file/read.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# 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#L166)
`@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)

Reads an array in NPY format from a given path.

Expand Down
16 changes: 8 additions & 8 deletions docs/0.3.0/org.jetbrains.bio.npy/-npy-file/write.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

# 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#L208)
`@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#L214)
`@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#L220)
`@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#L226)
`@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#L232)
`@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#L238)
`@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#L244)
`@JvmOverloads @JvmStatic fun write(path: `[`Path`](http://docs.oracle.com/javase/6/docs/api/java/nio/file/Path.html)`, data: Array<String>, 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#L250)
`@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<String>, 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)
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
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](#) call
serialized array prior to archiving. Thus each [write](write.md) call
requires N extra bytes of memory for an array of N bytes.

### Properties
Expand Down
2 changes: 1 addition & 1 deletion docs/0.3.0/org.jetbrains.bio.npy/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@
| Name | Summary |
|---|---|
| [NpyArray](-npy-array/index.md) | `class NpyArray`<br>A wrapper for NPY array data. |
| [NpyFile](-npy-file/index.md) | `class NpyFile`<br>A file in NPY format. |
| [NpyFile](-npy-file/index.md) | `object NpyFile`<br>A file in NPY format. |
| [NpzEntry](-npz-entry/index.md) | `class NpzEntry`<br>A stripped down NPY header for an array in NPZ. |
| [NpzFile](-npz-file/index.md) | `object NpzFile`<br>A ZIP file where each individual file is in NPY format. |
2 changes: 1 addition & 1 deletion src/main/kotlin/org/jetbrains/bio/npy/Npy.kt
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ class NpyArray(

override fun toString() = MoreObjects.toStringHelper(this)
.add("data", Arrays.deepToString(arrayOf(data))
.removeSurrounding("[", "]")
.removeSurrounding("[", "]"))
.add("shape", Arrays.toString(shape))
.toString()
}
Expand Down

0 comments on commit 861958f

Please sign in to comment.