DataSet Class Reference

#include <DataSet.h>

Inheritance diagram for DataSet:

Public Member Functions
	DataSet (int nExamples=0, int dim=0)
	Constructor. More...
virtual	~DataSet ()
int	dim () const
	Returns the dimension of each example. More...
int	nExamples () const
	Returns the number of examples. More...
virtual void	init ()
virtual void	reset ()
	To be called before every episode. More...
virtual void	setExample (int t)=0
	Sets this->example to given index t. More...

Public Attributes
int	_nExamples
	Number of examples in the dataset. More...
int	_dim
	Dimension of the example. More...
real *	example
	Current example. More...

Detailed Description

Provides an interface to manipulate all kind of data.

Constructor & Destructor Documentation

DataSet::DataSet	(	int	nExamples = 0,
		int	dim = 0
	)

Constructor.

DataSet::~DataSet ( )

virtual

Member Function Documentation

int DataSet::dim ( ) const

inline

Returns the dimension of each example.

void DataSet::init ( )

virtual

To be called before training. Should allocate example, among other things. Default version allocates example to the size of dim.

Reimplemented in TupleDataSet, XFileDataSet, MultiDataSet, DiskXFileDataSet, and SubDataSet.

int DataSet::nExamples ( ) const

inline

Returns the number of examples.

virtual void DataSet::reset ( )

inlinevirtual

To be called before every episode.

Reimplemented in TupleDataSet, MultiDataSet, XFileDataSet, DiskXFileDataSet, and SubDataSet.

virtual void DataSet::setExample ( int  t )

pure virtual

Sets this->example to given index t.

Implemented in TupleDataSet, MultiDataSet, XFileDataSet, SubDataSet, DiskXFileDataSet, and MemoryDataSet.

Member Data Documentation

int DataSet::_dim

Dimension of the example.

int DataSet::_nExamples

Number of examples in the dataset.

real* DataSet::example

Current example.

---

The documentation for this class was generated from the following files:

• src/qualia/learning/DataSet.h
• src/qualia/learning/DataSet.cpp