File prediction.hpp

class IPrediction : public IIndexVector
#include <prediction.hpp>

Defines an interface for all classes that store the scores that are predicted by a rule.

Subclassed by IEvaluatedPrediction

Public Functions

inline virtual ~IPrediction() override
virtual void sort() = 0

Sorts the scores that are stored by this prediction in increasing order by the indices of the labels they correspond to.

virtual void postProcess(const IPostProcessor &postProcessor) = 0

Post-processes the scores that are stored by this prediction.

Parameters:

postProcessor – A reference to an object of type IPostProcessor that sould be used for post-processing

virtual void set(View<float64>::const_iterator begin, View<float64>::const_iterator end) = 0

Sets the scores that are stored by this prediction to the values in a given iterator.

Parameters:

  • begin – An iterator to the beginning of the values to be set

  • end – An iterator to the end of the values to be set

virtual void set(BinnedConstIterator<float64> begin, BinnedConstIterator<float64> end) = 0

Sets the scores that are stored by this prediction to the values in a given iterator.

Parameters:

  • begin – An iterator to the beginning of the values to be set

  • end – An iterator to the end of the values to be set

virtual void apply(IStatistics &statistics, uint32 statisticIndex) const = 0

Updates given statistics by applying this prediction.

Parameters:

  • statistics – A reference to an object of type IStatistics to be updated

  • statisticIndex – The index of the statistic to be updated

virtual void revert(IStatistics &statistics, uint32 statisticIndex) const = 0

Updates given statistics by reverting this prediction.

Parameters:

  • statistics – A reference to an object of type IStatistics to be updated

  • statisticIndex – The index of the statistic to be updated

virtual std::unique_ptr<IStatisticsSubset> createStatisticsSubset(const IStatistics &statistics, const EqualWeightVector &weights) const = 0

Creates and returns a new subset of the given statistics that only contains the labels whose indices are stored in this vector.

Parameters:

  • statistics – A reference to an object of type IStatistics that should be used to create the subset

  • weights – A reference to an object of type EqualWeightVector that provides access to the weights of individual training examples

Returns:

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

virtual std::unique_ptr<IStatisticsSubset> createStatisticsSubset(const IStatistics &statistics, const BitWeightVector &weights) const = 0

Creates and returns a new subset of the given statistics that only contains the labels whose indices are stored in this vector.

Parameters:

  • statistics – A reference to an object of type IStatistics that should be used to create the subset

  • weights – A reference to an object of type BitWeightVector that provides access to the weights of individual training examples

Returns:

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

virtual std::unique_ptr<IStatisticsSubset> createStatisticsSubset(const IStatistics &statistics, const DenseWeightVector<uint32> &weights) const = 0

Creates and returns a new subset of the given statistics that only contains the labels whose indices are stored in this vector.

Parameters:

  • statistics – A reference to an object of type IStatistics that should be used to create the subset

  • weights – A reference to an object of type DenseWeightVector<uint32> that provides access to the weights of individual training examples

Returns:

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

virtual std::unique_ptr<IStatisticsSubset> createStatisticsSubset(const IStatistics &statistics, const OutOfSampleWeightVector<EqualWeightVector> &weights) const = 0

Creates and returns a new subset of the given statistics that only contains the labels whose indices are stored in this vector.

Parameters:

  • statistics – A reference to an object of type IStatistics that should be used to create the subset

  • weights – A reference to an object of type OutOfSampleWeightVector<EqualWeightVector> that provides access to the weights of individual training examples

Returns:

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

virtual std::unique_ptr<IStatisticsSubset> createStatisticsSubset(const IStatistics &statistics, const OutOfSampleWeightVector<BitWeightVector> &weights) const = 0

Creates and returns a new subset of the given statistics that only contains the labels whose indices are stored in this vector.

Parameters:

  • statistics – A reference to an object of type IStatistics that should be used to create the subset

  • weights – A reference to an object of type OutOfSampleWeightVector<BitWeightVector> that provides access to the weights of individual training examples

Returns:

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

virtual std::unique_ptr<IStatisticsSubset> createStatisticsSubset(const IStatistics &statistics, const OutOfSampleWeightVector<DenseWeightVector<uint32>> &weights) const = 0

Creates and returns a new subset of the given statistics that only contains the labels whose indices are stored in this vector.

Parameters:

  • statistics – A reference to an object of type IStatistics that should be used to create the subset

  • weights – A reference to an object of type OutOfSampleWeightVector<DenseWeightVector<uint32>> that provides access to the weights of individual training examples

Returns:

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

virtual std::unique_ptr<IHead> createHead() const = 0

Creates and returns a head that contains the scores that are stored by this prediction.

Returns:

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