org.openimaj.data.dataset

Interface ListDataset<INSTANCE>

Type Parameters:

INSTANCE - the type of instances in the dataset

All Superinterfaces:

Collection<INSTANCE>, Dataset<INSTANCE>, Iterable<INSTANCE>, List<INSTANCE>

All Known Subinterfaces:

ShapeModelDataset<IMAGE>

All Known Implementing Classes:

BingImageDataset, Corel5kDataset, FDDBDataset, FlickrImageDataset, ListBackedDataset, ReadableListDataset, UKBenchListDataset, VFSListDataset

public interface ListDataset<INSTANCE>
extends Dataset<INSTANCE>, List<INSTANCE>

A ListDataset is a Dataset presented as an ordered list of instances. For convenience it extends the List interface; note however, that many dataset implementations will be read-only.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Method Summary

Modifier and Type	Method and Description
INSTANCE	getInstance(int index) Returns the instance at the specified position in this dataset.

Methods inherited from interface org.openimaj.data.dataset.Dataset

getRandomInstance, numInstances

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

getInstance

INSTANCE getInstance(int index)

Returns the instance at the specified position in this dataset.

Parameters:

index - index of the instance to return

Returns:

the element at the specified position in this list

Throws:

IndexOutOfBoundsException - if the index is out of range ( index < 0 || index >= size())