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

Result of PredictModel::predict(). More...

#include <fastlowess.hpp>

Public Member Functions

 PredictResult ()=default
 
 PredictResult (const fastlowess_CppPredictResult &c_result)
 
 ~PredictResult ()
 
 PredictResult (const PredictResult &)=delete
 
PredictResult & operator= (const PredictResult &)=delete
 
 PredictResult (PredictResult &&other) noexcept
 
PredictResult & operator= (PredictResult &&other) noexcept
 
size_t size () const
 Number of query points.
 
bool valid () const
 Check if result is valid.
 
std::string error () const
 Get error message (empty if no error)
 
std::vector< double > y () const
 Predicted y values, one per query point.
 
std::vector< double > standard_errors () const
 Standard errors (empty if not requested)
 
std::vector< double > confidence_lower () const
 Lower confidence interval bounds (empty if not requested)
 
std::vector< double > confidence_upper () const
 Upper confidence interval bounds (empty if not requested)
 
std::vector< double > prediction_lower () const
 Lower prediction interval bounds (empty if not requested)
 
std::vector< double > prediction_upper () const
 Upper prediction interval bounds (empty if not requested)
 
std::vector< double > derivative () const
 Local fit's derivative (slope) at each query point (empty if not requested)
 

Detailed Description

Result of PredictModel::predict().

RAII wrapper that automatically frees the underlying C result.

Constructor & Destructor Documentation

◆ PredictResult() [1/4]

fastlowess::PredictResult::PredictResult ( )
default

◆ PredictResult() [2/4]

fastlowess::PredictResult::PredictResult ( const fastlowess_CppPredictResult &  c_result)
inlineexplicit

◆ ~PredictResult()

fastlowess::PredictResult::~PredictResult ( )
inline

◆ PredictResult() [3/4]

fastlowess::PredictResult::PredictResult ( const PredictResult &  )
delete

◆ PredictResult() [4/4]

fastlowess::PredictResult::PredictResult ( PredictResult &&  other)
inlinenoexcept

Member Function Documentation

◆ confidence_lower()

std::vector< double > fastlowess::PredictResult::confidence_lower ( ) const
inline

Lower confidence interval bounds (empty if not requested)

◆ confidence_upper()

std::vector< double > fastlowess::PredictResult::confidence_upper ( ) const
inline

Upper confidence interval bounds (empty if not requested)

◆ derivative()

std::vector< double > fastlowess::PredictResult::derivative ( ) const
inline

Local fit's derivative (slope) at each query point (empty if not requested)

◆ error()

std::string fastlowess::PredictResult::error ( ) const
inline

Get error message (empty if no error)

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ prediction_lower()

std::vector< double > fastlowess::PredictResult::prediction_lower ( ) const
inline

Lower prediction interval bounds (empty if not requested)

◆ prediction_upper()

std::vector< double > fastlowess::PredictResult::prediction_upper ( ) const
inline

Upper prediction interval bounds (empty if not requested)

◆ size()

size_t fastlowess::PredictResult::size ( ) const
inline

Number of query points.

◆ standard_errors()

std::vector< double > fastlowess::PredictResult::standard_errors ( ) const
inline

Standard errors (empty if not requested)

◆ valid()

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

Check if result is valid.

◆ y()

std::vector< double > fastlowess::PredictResult::y ( ) const
inline

Predicted y values, one per query point.


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