SG++-Doxygen-Documentation
sgpp::datadriven::DataShufflingFunctor Class Referenceabstract

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:
sgpp::datadriven::DataShufflingFunctorCrossValidation sgpp::datadriven::DataShufflingFunctorRandom sgpp::datadriven::DataShufflingFunctorSequential

Public Member Functions

virtual DataShufflingFunctorclone () 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...
 
DataShufflingFunctoroperator= (const DataShufflingFunctor &rhs)=default
 
DataShufflingFunctoroperator= (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

sgpp::datadriven::DataShufflingFunctor::DataShufflingFunctor ( )
sgpp::datadriven::DataShufflingFunctor::DataShufflingFunctor ( const DataShufflingFunctor rhs)
default
sgpp::datadriven::DataShufflingFunctor::DataShufflingFunctor ( DataShufflingFunctor &&  rhs)
default
virtual sgpp::datadriven::DataShufflingFunctor::~DataShufflingFunctor ( )
virtualdefault

Member Function Documentation

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.

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
idxthe original index
numSamplesthe 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.

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

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