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

Result of LOWESS smoothing operation. More...

#include <fastlowess.hpp>

Public Member Functions

 LowessResult ()
 
 LowessResult (const fastlowess_CppLowessResult &c_result)
 
 ~LowessResult ()
 
 LowessResult (const LowessResult &)=delete
 
LowessResult & operator= (const LowessResult &)=delete
 
 LowessResult (LowessResult &&other) noexcept
 
LowessResult & operator= (LowessResult &&other) noexcept
 
size_t size () const
 Number of data points.
 
bool valid () const
 Check if result is valid.
 
std::string error () const
 Get error message (empty if no error)
 
double x_value (size_t index) const
 Access x value at index.
 
double y_value (size_t index) const
 Access smoothed y value at index.
 
std::vector< double > x_vector () const
 Get x values as vector.
 
std::vector< double > y_vector () const
 Get smoothed y values as vector.
 
std::vector< double > residuals () const
 Get residuals (empty if not computed)
 
std::vector< double > standard_errors () const
 Get standard errors (empty if not computed)
 
std::vector< double > confidence_lower () const
 Get confidence interval lower bounds.
 
std::vector< double > confidence_upper () const
 Get confidence interval upper bounds.
 
std::vector< double > prediction_lower () const
 Get prediction interval lower bounds.
 
std::vector< double > prediction_upper () const
 Get prediction interval upper bounds.
 
std::vector< double > robustness_weights () const
 Get robustness weights (empty if not computed)
 
std::vector< double > derivative () const
 Get the per-point local fit derivative (slope) (empty if not computed)
 
std::vector< double > cv_scores () const
 Get cross-validation scores (empty if not computed)
 
double fraction_used () const
 Fraction used for smoothing.
 
int iterations_used () const
 Number of iterations performed (-1 if not available)
 
Diagnostics diagnostics () const
 Get diagnostics.
 
PredictModel predict_model ()
 Extract the retained predict model (only available when LowessOptions::retain_model was set to true before fit()).
 

Detailed Description

Result of LOWESS smoothing operation.

RAII wrapper that automatically frees the underlying C result.

Constructor & Destructor Documentation

◆ LowessResult() [1/4]

fastlowess::LowessResult::LowessResult ( )
inline

◆ LowessResult() [2/4]

fastlowess::LowessResult::LowessResult ( const fastlowess_CppLowessResult &  c_result)
inlineexplicit

◆ ~LowessResult()

fastlowess::LowessResult::~LowessResult ( )
inline

◆ LowessResult() [3/4]

fastlowess::LowessResult::LowessResult ( const LowessResult &  )
delete

◆ LowessResult() [4/4]

fastlowess::LowessResult::LowessResult ( LowessResult &&  other)
inlinenoexcept

Member Function Documentation

◆ confidence_lower()

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

Get confidence interval lower bounds.

◆ confidence_upper()

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

Get confidence interval upper bounds.

◆ cv_scores()

std::vector< double > fastlowess::LowessResult::cv_scores ( ) const
inline

Get cross-validation scores (empty if not computed)

◆ derivative()

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

Get the per-point local fit derivative (slope) (empty if not computed)

◆ diagnostics()

Diagnostics fastlowess::LowessResult::diagnostics ( ) const
inline

Get diagnostics.

◆ error()

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

Get error message (empty if no error)

◆ fraction_used()

double fastlowess::LowessResult::fraction_used ( ) const
inline

Fraction used for smoothing.

◆ iterations_used()

int fastlowess::LowessResult::iterations_used ( ) const
inline

Number of iterations performed (-1 if not available)

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ predict_model()

PredictModel fastlowess::LowessResult::predict_model ( )
inline

Extract the retained predict model (only available when LowessOptions::retain_model was set to true before fit()).

Transfers ownership: subsequent calls return an invalid (empty) PredictModel. Check PredictModel::valid() before use.

◆ prediction_lower()

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

Get prediction interval lower bounds.

◆ prediction_upper()

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

Get prediction interval upper bounds.

◆ residuals()

std::vector< double > fastlowess::LowessResult::residuals ( ) const
inline

Get residuals (empty if not computed)

◆ robustness_weights()

std::vector< double > fastlowess::LowessResult::robustness_weights ( ) const
inline

Get robustness weights (empty if not computed)

◆ size()

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

Number of data points.

◆ standard_errors()

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

Get standard errors (empty if not computed)

◆ valid()

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

Check if result is valid.

◆ x_value()

double fastlowess::LowessResult::x_value ( size_t  index) const
inline

Access x value at index.

◆ x_vector()

std::vector< double > fastlowess::LowessResult::x_vector ( ) const
inline

Get x values as vector.

◆ y_value()

double fastlowess::LowessResult::y_value ( size_t  index) const
inline

Access smoothed y value at index.

◆ y_vector()

std::vector< double > fastlowess::LowessResult::y_vector ( ) const
inline

Get smoothed y values as vector.


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