org.openimaj.data

Interface DataSource<DATATYPE>

Type Parameters:

DATATYPE - the data type which can be returned

All Superinterfaces:

Iterable<DATATYPE>

All Known Implementing Classes:

AbstractDataSource, AbstractMultiListDataSource, ArrayBackedDataSource, ByteArrayBackedDataSource, DoubleArrayBackedDataSource, FloatArrayBackedDataSource, IndexedViewDataSource, IntArrayBackedDataSource, LocalFeatureListDataSource, LongArrayBackedDataSource, RandomSampleDataSource, SampleBatchByteDataSource, SampleBatchIntDataSource, ShortArrayBackedDataSource

public interface DataSource<DATATYPE>
extends Iterable<DATATYPE>

A source which returns data of type DATATYPE. Classes which implement this interface must support random access to rows as well as the ability to get random subsets of data.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk), Sina Samangooei (ss@ecs.soton.ac.uk)

Method Summary

Modifier and Type	Method and Description
DATATYPE[]	createTemporaryArray(int size) Create a temporary array suitable for use with the getRandomRows(Object[]) and getData(int, int, Object[]) methods.
DATATYPE	getData(int row) Get the data for a given row
void	getData(int startRow, int stopRow, DATATYPE[] data) Get data between given rows.
void	getRandomRows(DATATYPE[] data)
int	numDimensions()
int	size()

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getData

void getData(int startRow,
             int stopRow,
             DATATYPE[] data)

Get data between given rows. startRow must be > 0, stopRow must be smaller than size(). data is guaranteed to have (stopRow - startRow) valid entries

Parameters:

startRow - where to start (inclusive)

stopRow - where to stop (exclusive)

data - the array to fill

getData

DATATYPE getData(int row)

Get the data for a given row

Parameters:

row - the row number

Returns:

the data for the row

numDimensions

int numDimensions()

Returns:

Number of dimensions of each data point

getRandomRows

void getRandomRows(DATATYPE[] data)

Parameters:

data - a random set of data. This array is guaranteed to be filled.

size

int size()

Returns:

the number of data points

createTemporaryArray

DATATYPE[] createTemporaryArray(int size)

Create a temporary array suitable for use with the getRandomRows(Object[]) and getData(int, int, Object[]) methods.

Parameters:

size - the size of the array

Returns:

the array