org.cognity.data

Interface DataSet

All Superinterfaces:

Collection<DataExample>, Iterable<DataExample>

All Known Implementing Classes:

ListDataSet

public interface DataSet
extends Collection<DataExample>

A data set is an ordered collection of unique data examples. All input and target vectors in the data set must have the same constant size, that is, the following is true for all data examples in the set:

dataExample.getInputSize() == a
dataExample.getTargetSize() == b

where a and b are fixed non-negative integers.

Author:

Artur Markiewicz

Method Summary

Methods

Modifier and Type	Method and Description
DataExample	get(int index) Returns a data example at specified position.
int	getInputSize() Returns the size of input vectors in this data set.
int	getTargetSize() Return the size of target vectors in this data set.
boolean	isSupervised() Returns true if this data set is supervised.

Methods inherited from interface java.util.Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Method Detail

get

DataExample get(int index)

Returns a data example at specified position.

Parameters:

index - the data example position. Cannot be negative.

Returns:

a data example at specified position

getInputSize

int getInputSize()

Returns the size of input vectors in this data set.

Returns:

the size of input vectors in this data set

getTargetSize

int getTargetSize()

Return the size of target vectors in this data set.

Returns:

the size of target vectors in this data set

isSupervised

boolean isSupervised()

Returns true if this data set is supervised. The data set is supervised if and only if all underlying data examples are supervised.

Returns:

true if this data set is supervised