fastlowess-cpp
High-performance LOWESS smoothing
Loading...
Searching...
No Matches
fastlowess::PredictModel Class Reference

Retained fitted-model state enabling out-of-sample predict(). More...

#include <fastlowess.hpp>

Public Member Functions

 PredictModel ()=default
 
 PredictModel (fastlowess_CppPredictHandle *handle)
 
 ~PredictModel ()
 
 PredictModel (const PredictModel &)=delete
 
PredictModel & operator= (const PredictModel &)=delete
 
 PredictModel (PredictModel &&other) noexcept
 
PredictModel & operator= (PredictModel &&other) noexcept
 
bool valid () const
 True if this model was actually retained (retain_model was set).
 
PredictResult predict (const std::vector< double > &new_x, const PredictOptions &options={}) const
 Evaluate the fitted model at out-of-sample query points not in the training set.
 

Detailed Description

Retained fitted-model state enabling out-of-sample predict().

Obtained via LowessResult::predict_model(), only available when LowessOptions::retain_model was set to true before fit().

Constructor & Destructor Documentation

◆ PredictModel() [1/4]

fastlowess::PredictModel::PredictModel ( )
default

◆ PredictModel() [2/4]

fastlowess::PredictModel::PredictModel ( fastlowess_CppPredictHandle *  handle)
inlineexplicit

◆ ~PredictModel()

fastlowess::PredictModel::~PredictModel ( )
inline

◆ PredictModel() [3/4]

fastlowess::PredictModel::PredictModel ( const PredictModel &  )
delete

◆ PredictModel() [4/4]

fastlowess::PredictModel::PredictModel ( PredictModel &&  other)
inlinenoexcept

Member Function Documentation

◆ operator=() [1/2]

PredictModel & fastlowess::PredictModel::operator= ( const PredictModel &  )
delete

◆ operator=() [2/2]

PredictModel & fastlowess::PredictModel::operator= ( PredictModel &&  other)
inlinenoexcept

◆ predict()

PredictResult fastlowess::PredictModel::predict ( const std::vector< double > &  new_x,
const PredictOptions &  options = {} 
) const
inline

Evaluate the fitted model at out-of-sample query points not in the training set.

◆ valid()

bool fastlowess::PredictModel::valid ( ) const
inline

True if this model was actually retained (retain_model was set).


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