File feature_matrix_row_wise.hpp

class IRowWiseFeatureMatrix : public IFeatureMatrix
#include <feature_matrix_row_wise.hpp>

Defines an interface for all feature matrices that provide row-wise access to the feature values of examples.

Subclassed by ICContiguousFeatureMatrix, ICsrFeatureMatrix

Public Functions

inline virtual ~IRowWiseFeatureMatrix() override
virtual std::unique_ptr<IBinaryPredictor> createBinaryPredictor(const IBinaryPredictorFactory &factory, const IRuleModel &ruleModel, const IOutputSpaceInfo &outputSpaceInfo, const IMarginalProbabilityCalibrationModel &marginalProbabilityCalibrationModel, const IJointProbabilityCalibrationModel &jointProbabilityCalibrationModel, uint32 numLabels) const = 0

Creates and returns a new instance of the class IBinaryPredictor, based on the type of this feature matrix.

Parameters:

  • factory – A reference to an object of type IBinaryPredictorFactory that should be used to create the instance

  • ruleModel – A reference to an object of type IRuleModel that should be used to obtain predictions

  • outputSpaceInfo – A reference to an object of type IOutputSpaceInfo that provides information about the output space that may be used as a basis for making predictions

  • marginalProbabilityCalibrationModel – A reference to an object of type IMarginalProbabilityCalibrationModel that may be used for the calibration of marginal probabilities

  • jointProbabilityCalibrationModel – A reference to an object of type IJointProbabilityCalibrationModel that may be used for the calibration of joint probabilities

  • numLabels – The number of labels to predict for

Returns:

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

virtual std::unique_ptr<ISparseBinaryPredictor> createSparseBinaryPredictor(const ISparseBinaryPredictorFactory &factory, const IRuleModel &ruleModel, const IOutputSpaceInfo &outputSpaceInfo, const IMarginalProbabilityCalibrationModel &marginalProbabilityCalibrationModel, const IJointProbabilityCalibrationModel &jointProbabilityCalibrationModel, uint32 numLabels) const = 0

Creates and returns a new instance of the class ISparseBinaryPredictor, based on the type of this feature matrix.

Parameters:

  • factory – A reference to an object of type ISparseBinaryPredictorFactory that should be used to create the instance

  • ruleModel – A reference to an object of type IRuleModel that should be used to obtain predictions

  • outputSpaceInfo – A reference to an object of type IOutputSpaceInfo that provides information about the output space that may be used as a basis for making predictions

  • marginalProbabilityCalibrationModel – A reference to an object of type IMarginalProbabilityCalibrationModel that may be used for the calibration of marginal probabilities

  • jointProbabilityCalibrationModel – A reference to an object of type IJointProbabilityCalibrationModel that may be used for the calibration of joint probabilities

  • numLabels – The number of labels to predict for

Returns:

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

virtual std::unique_ptr<IScorePredictor> createScorePredictor(const IScorePredictorFactory &factory, const IRuleModel &ruleModel, const IOutputSpaceInfo &outputSpaceInfo, uint32 numOutputs) const = 0

Creates and returns a new instance of the class IScorePredictor, based on the type of this feature matrix.

Parameters:

  • factory – A reference to an object of type IScorePredictorFactory that should be used to create the instance

  • ruleModel – A reference to an object of type IRuleModel that should be used to obtain predictions

  • outputSpaceInfo – A reference to an object of type IOutputSpaceInfo that provides information about the output space that may be used as a basis for making predictions

  • numOutputs – The number of outputs to predict for

Returns:

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

virtual std::unique_ptr<IProbabilityPredictor> createProbabilityPredictor(const IProbabilityPredictorFactory &factory, const IRuleModel &ruleModel, const IOutputSpaceInfo &outputSpaceInfo, const IMarginalProbabilityCalibrationModel &marginalProbabilityCalibrationModel, const IJointProbabilityCalibrationModel &jointProbabilityCalibrationModel, uint32 numLabels) const = 0

Creates and returns a new instance of the class IProbabilityPredictor, based on the type of this feature matrix.

Parameters:

  • factory – A reference to an object of type IProbabilityPredictorFactory that should be used to create the instance

  • ruleModel – A reference to an object of type IRuleModel that should be used to obtain predictions

  • outputSpaceInfo – A reference to an object of type IOutputSpaceInfo that provides information about the output space that may be used as a basis for making predictions

  • marginalProbabilityCalibrationModel – A reference to an object of type IMarginalProbabilityCalibrationModel that may be used for the calibration of marginal probabilities

  • jointProbabilityCalibrationModel – A reference to an object of type IJointProbabilityCalibrationModel that may be used for the calibration of joint probabilities

  • numLabels – The number of labels to predict for

Returns:

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