Class VectorFileIterators

java.lang.Object

uk.co.parnmatt.vector.reader.VectorFileIterators

public final class VectorFileIterators
extends Object

Reads binary encoded vectors from files with default buffering.

try (CloseableIterator<float[]> vectors = VectorFileIterators.floats(path)) {
    while (vectors.hasNext()) {
        float[] vector = vectors.next();
        // process vector
    }
}

For control over the source, buffering strategy, and byte order, compose a reader with VectorReader.

Since:

0.1.0

Method Summary

Modifier and Type	Method	Description
static CloseableIterator<byte[]>	bytes(Path path)	Reads byte vectors from a file
static CloseableIterator<double[]>	doubles(Path path)	Reads double vectors from a file
static CloseableIterator<float[]>	floats(Path path)	Reads float vectors from a file
static CloseableIterator<int[]>	ints(Path path)	Reads int vectors from a file
static CloseableIterator<long[]>	longs(Path path)	Reads long vectors from a file
static CloseableIterator<short[]>	shorts(Path path)	Reads short vectors from a file

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

bytes

@MustBeClosed
public static CloseableIterator<byte[]> bytes(Path path)
                                       throws IOException

Reads byte vectors from a file

Parameters:

path - the path to the file which to read

Returns:

a closeable iterator over the file's byte vectors

Throws:

IOException

Since:

0.4.0

See Also:

• VectorReader

shorts

@MustBeClosed
public static CloseableIterator<short[]> shorts(Path path)
                                         throws IOException

Reads short vectors from a file

Parameters:

path - the path to the file which to read

Returns:

a closeable iterator over the file's short vectors

Throws:

IOException

Since:

0.4.0

See Also:

• VectorReader

ints

@MustBeClosed
public static CloseableIterator<int[]> ints(Path path)
                                     throws IOException

Reads int vectors from a file

Parameters:

path - the path to the file which to read

Returns:

a closeable iterator over the file's int vectors

Throws:

IOException

Since:

0.4.0

See Also:

• VectorReader

longs

@MustBeClosed
public static CloseableIterator<long[]> longs(Path path)
                                       throws IOException

Reads long vectors from a file

Parameters:

path - the path to the file which to read

Returns:

a closeable iterator over the file's long vectors

Throws:

IOException

Since:

0.4.0

See Also:

• VectorReader

floats

@MustBeClosed
public static CloseableIterator<float[]> floats(Path path)
                                         throws IOException

Reads float vectors from a file

Parameters:

path - the path to the file which to read

Returns:

a closeable iterator over the file's float vectors

Throws:

IOException

Since:

0.4.0

See Also:

• VectorReader

doubles

@MustBeClosed
public static CloseableIterator<double[]> doubles(Path path)
                                           throws IOException

Reads double vectors from a file

Parameters:

path - the path to the file which to read

Returns:

a closeable iterator over the file's double vectors

Throws:

IOException

Since:

0.4.0

See Also:

• VectorReader