org.jetbrains.bio.npy

Class NpzFile.Reader

org.jetbrains.bio.npy.NpzFile.Reader

Enclosing class:

NpzFile

public static class NpzFile.Reader

A reader for NPZ format.

Method Summary

Modifier and Type	Method and Description
void	close()
NpzFile.Reader	copy(java.nio.file.Path path) A reader for NPZ format.
boolean	equals(java.lang.Object p)
NpyArray	get(java.lang.String name, int step) Returns an array for a given name.
int	hashCode()
java.util.List<org.jetbrains.bio.npy.NpzEntry>	introspect() Returns a mapping from array names to the corresponding scalar types in Java.
java.lang.String	toString()

Method Detail

introspect

@NotNull
public java.util.List<org.jetbrains.bio.npy.NpzEntry> introspect()

Returns a mapping from array names to the corresponding scalar types in Java.

get

@NotNull
public NpyArray get(@NotNull
                              java.lang.String name,
                              int step)

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.

close

public void close()

copy

@NotNull
public NpzFile.Reader copy(@NotNull
                                     java.nio.file.Path path)

A reader for NPZ format.

toString

@NotNull
public java.lang.String toString()

hashCode

public int hashCode()

equals

public boolean equals(@Nullable
                      java.lang.Object p)