sgpp::datadriven::DataShufflingFunctor Class Reference

A class to provide functionality to shuffle (reorder) the data samples before the sample provider accesses it. More...

#include <DataShufflingFunctor.hpp>

Inheritance diagram for sgpp::datadriven::DataShufflingFunctor:

Public Member Functions
virtual DataShufflingFunctor *	clone () const =0
	Polymorphic clone pattern. More...
	DataShufflingFunctor ()
	DataShufflingFunctor (const DataShufflingFunctor &rhs)=default
	DataShufflingFunctor (DataShufflingFunctor &&rhs)=default
virtual size_t	operator() (size_t idx, size_t numSamples)=0
	Overload the function-call operator that maps indexes to indexes via a permutation of the entire index set. More...
DataShufflingFunctor &	operator= (const DataShufflingFunctor &rhs)=default
DataShufflingFunctor &	operator= (DataShufflingFunctor &&rhs)=default
virtual	~DataShufflingFunctor ()=default

Detailed Description

A class to provide functionality to shuffle (reorder) the data samples before the sample provider accesses it.

This is neccessary for cross validation and general shuffling of data.

Constructor & Destructor Documentation

DataShufflingFunctor() [1/3]

sgpp::datadriven::DataShufflingFunctor::DataShufflingFunctor

(

)

DataShufflingFunctor() [2/3]

sgpp::datadriven::DataShufflingFunctor::DataShufflingFunctor ( const DataShufflingFunctor &  rhs )

default

DataShufflingFunctor() [3/3]

sgpp::datadriven::DataShufflingFunctor::DataShufflingFunctor ( DataShufflingFunctor &&  rhs )

default

~DataShufflingFunctor()

virtual sgpp::datadriven::DataShufflingFunctor::~DataShufflingFunctor ( )

virtualdefault

Member Function Documentation

clone()

virtual DataShufflingFunctor* sgpp::datadriven::DataShufflingFunctor::clone ( ) const

pure virtual

Polymorphic clone pattern.

Returns

deep copy of this object. New object is owned by caller.

Implemented in sgpp::datadriven::DataShufflingFunctorCrossValidation, sgpp::datadriven::DataShufflingFunctorRandom, and sgpp::datadriven::DataShufflingFunctorSequential.

operator()()

virtual size_t sgpp::datadriven::DataShufflingFunctor::operator() ( size_t  idx, size_t  numSamples  )

pure virtual

Overload the function-call operator that maps indexes to indexes via a permutation of the entire index set.

Parameters

idx	the original index
numSamples	the number of indexes to permute in total

Returns

idx the index after the permutation

Implemented in sgpp::datadriven::DataShufflingFunctorCrossValidation, sgpp::datadriven::DataShufflingFunctorRandom, and sgpp::datadriven::DataShufflingFunctorSequential.

operator=() [1/2]

DataShufflingFunctor& sgpp::datadriven::DataShufflingFunctor::operator= ( const DataShufflingFunctor &  rhs )

default

operator=() [2/2]

DataShufflingFunctor& sgpp::datadriven::DataShufflingFunctor::operator= ( DataShufflingFunctor &&  rhs )

default

---

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

• datadriven/src/sgpp/datadriven/datamining/modules/dataSource/shuffling/DataShufflingFunctor.hpp
• datadriven/src/sgpp/datadriven/datamining/modules/dataSource/shuffling/DataShufflingFunctor.cpp