File instance_sampling.hpp

class IInstanceSampling
#include <instance_sampling.hpp>

Defines an interface for all classes that implement a method for sampling training examples.

Public Functions

inline virtual ~IInstanceSampling()
virtual const IWeightVector &sample(RNG &rng) = 0

Creates and returns a sample of the available training examples.

Parameters:

rng – A reference to an object of type RNG, implementing the random number generator to be used

Returns:

A reference to an object type WeightVector that provides access to the weights of the individual training examples

class IInstanceSamplingFactory
#include <instance_sampling.hpp>

Defines an interface for all factories that allow to create instances of the type IInstanceSampling.

Public Functions

inline virtual ~IInstanceSamplingFactory()
virtual std::unique_ptr<IInstanceSampling> create(const CContiguousView<const uint8> &labelMatrix, const SinglePartition &partition, IStatistics &statistics) const = 0

Creates and returns a new object of type IInstanceSampling.

Parameters:

  • labelMatrix – A reference to an object of type CContiguousView that provides access to the labels of the training examples

  • partition – A reference to an object of type SinglePartition that provides access to the indices of the training examples that are included in the training set

  • statistics – A reference to an object of type IStatistics that provides access to the statistics + which serve as a basis for learning rules

Returns:

An unique pointer to an object of type IInstanceSampling that has been created

virtual std::unique_ptr<IInstanceSampling> create(const CContiguousView<const uint8> &labelMatrix, BiPartition &partition, IStatistics &statistics) const = 0

Creates and returns a new object of type IInstanceSampling.

Parameters:

  • labelMatrix – A reference to an object of type CContiguousView that provides access to the labels of the training examples

  • partition – A reference to an object of type BiPartition that provides access to the indices of the training examples that are included in the training set and the holdout set, respectively

  • statistics – A reference to an object of type IStatistics that provides access to the statistics + which serve as a basis for learning rules

Returns:

An unique pointer to an object of type IInstanceSampling that has been created

virtual std::unique_ptr<IInstanceSampling> create(const BinaryCsrView &labelMatrix, const SinglePartition &partition, IStatistics &statistics) const = 0

Creates and returns a new object of type IInstanceSampling.

Parameters:

  • labelMatrix – A reference to an object of type BinaryCsrView that provides access to the labels of the training examples

  • partition – A reference to an object of type SinglePartition that provides access to the indices of the training examples that are included in the training set

  • statistics – A reference to an object of type IStatistics that provides access to the statistics + which serve as a basis for learning rules

Returns:

An unique pointer to an object of type IInstanceSampling that has been created

virtual std::unique_ptr<IInstanceSampling> create(const BinaryCsrView &labelMatrix, BiPartition &partition, IStatistics &statistics) const = 0

Creates and returns a new object of type IInstanceSampling.

Parameters:

  • labelMatrix – A reference to an object of type BinaryCsrView that provides access to the labels of the training examples

  • partition – A reference to an object of type BiPartition that provides access to the indices of the training examples that are included in the training set and the holdout set, respectively

  • statistics – A reference to an object of type IStatistics that provides access to the statistics + which serve as a basis for learning rules

Returns:

An unique pointer to an object of type IInstanceSampling that has been created

class IInstanceSamplingConfig
#include <instance_sampling.hpp>

Defines an interface for all classes that allow to configure a method for sampling instances.

Subclassed by ExampleWiseStratifiedInstanceSamplingConfig, InstanceSamplingWithReplacementConfig, InstanceSamplingWithoutReplacementConfig, LabelWiseStratifiedInstanceSamplingConfig, NoInstanceSamplingConfig

Public Functions

inline virtual ~IInstanceSamplingConfig()
virtual std::unique_ptr<IInstanceSamplingFactory> createInstanceSamplingFactory() const = 0

Creates and returns a new object of type IInstanceSamplingFactory according to the specified configuration.

Returns:

An unique pointer to an object of type IInstanceSamplingFactory that has been created