Class VectorReader.Decoding

java.lang.Object

uk.co.parnmatt.vector.reader.VectorReader.Decoding

Enclosing class:

VectorReader

public static final class VectorReader.Decoding
extends Object

The choice of element type to decode each vector into.

Since:

0.4.0

Method Summary

Modifier and Type	Method	Description
<E> CloseableIterator<E>	as(ElementType<E> type)	Read vectors of the given element type.
CloseableIterator<byte[]>	bytes()	Deprecated, for removal: This API element is subject to removal in a future version. use as(ElementType) with ElementType.INT8 instead
CloseableIterator<double[]>	doubles()	Deprecated, for removal: This API element is subject to removal in a future version. use as(ElementType) with ElementType.FLOAT64 instead
CloseableIterator<float[]>	floats()	Deprecated, for removal: This API element is subject to removal in a future version. use as(ElementType) with ElementType.FLOAT32 instead
CloseableIterator<int[]>	ints()	Deprecated, for removal: This API element is subject to removal in a future version. use as(ElementType) with ElementType.INT32 instead
CloseableIterator<long[]>	longs()	Deprecated, for removal: This API element is subject to removal in a future version. use as(ElementType) with ElementType.INT64 instead
CloseableIterator<short[]>	shorts()	Deprecated, for removal: This API element is subject to removal in a future version. use as(ElementType) with ElementType.INT16 instead

Methods inherited from class Object

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

Method Details

as

@MustBeClosed
public <E> CloseableIterator<E> as(ElementType<E> type)
                            throws IOException

Read vectors of the given element type.

Type Parameters:

E - the array type a vector decodes into

Parameters:

type - the element type the source was written with

Returns:

a closeable iterator over the source's vectors

Throws:

IOException

Since:

1.1.0

bytes

@Deprecated(since="1.1.0",
            forRemoval=true)
@MustBeClosed
public CloseableIterator<byte[]> bytes()
                                throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

use as(ElementType) with ElementType.INT8 instead

Read byte vectors.

Returns:

a closeable iterator over the source's byte vectors

Throws:

IOException

shorts

@Deprecated(since="1.1.0",
            forRemoval=true)
@MustBeClosed
public CloseableIterator<short[]> shorts()
                                  throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

use as(ElementType) with ElementType.INT16 instead

Read short vectors.

Returns:

a closeable iterator over the source's short vectors

Throws:

IOException

ints

@Deprecated(since="1.1.0",
            forRemoval=true)
@MustBeClosed
public CloseableIterator<int[]> ints()
                              throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

use as(ElementType) with ElementType.INT32 instead

Read int vectors.

Returns:

a closeable iterator over the source's int vectors

Throws:

IOException

longs

@Deprecated(since="1.1.0",
            forRemoval=true)
@MustBeClosed
public CloseableIterator<long[]> longs()
                                throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

use as(ElementType) with ElementType.INT64 instead

Read long vectors.

Returns:

a closeable iterator over the source's long vectors

Throws:

IOException

floats

@Deprecated(since="1.1.0",
            forRemoval=true)
@MustBeClosed
public CloseableIterator<float[]> floats()
                                  throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

use as(ElementType) with ElementType.FLOAT32 instead

Read float vectors.

Returns:

a closeable iterator over the source's float vectors

Throws:

IOException

doubles

@Deprecated(since="1.1.0",
            forRemoval=true)
@MustBeClosed
public CloseableIterator<double[]> doubles()
                                    throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

use as(ElementType) with ElementType.FLOAT64 instead

Read double vectors.

Returns:

a closeable iterator over the source's double vectors

Throws:

IOException