PPC_KO_wrapper< solver, k_imp, valid_err_ret, cv_strat, cv_err_eval > Class Template Reference

Base virtual class for wrapping class that performs PPCKO computations. Which child class is constructed is selected run-time through virtual polymorphism. More...

#include <PPC_KO_wrapper.hpp>

Inheritance diagram for PPC_KO_wrapper< solver, k_imp, valid_err_ret, cv_strat, cv_err_eval >:

Public Member Functions
template<typename STOR_OBJ>
	PPC_KO_wrapper (STOR_OBJ &&data, int number_threads)
	Constructor.
virtual	~PPC_KO_wrapper ()=default
	Virtual destructor.
virtual void	call_ko ()=0
	Virtual method to call the correct PPCKO version at runtime.
KO_Traits::StoringMatrix	data () const
	Getter for the data matrix.
results_t< valid_err_ret >	results () const
	Getter for the results.
int	number_threads () const
	Getter for the number of threads for OMP.
results_t< valid_err_ret > &	results ()
	Setter for the results.

Detailed Description

template<SOLVER solver, K_IMP k_imp, VALID_ERR_RET valid_err_ret, CV_STRAT cv_strat, CV_ERR_EVAL cv_err_eval>
class PPC_KO_wrapper< solver, k_imp, valid_err_ret, cv_strat, cv_err_eval >

Base virtual class for wrapping class that performs PPCKO computations. Which child class is constructed is selected run-time through virtual polymorphism.

Template Parameters

solver	if algorithm solved inverting the regularized covariance or avoiding it through gep (not possible if retaining the number of PPCs with explanatory power criterion)
k_imp	if k is imposed or has to be found through explanatory power criterion
valid_err_ret	if validation error are stored
cv_strat	strategy for splitting training/validation sets
err_eval	how to evaluate the loss between prediction on validation set and validation set

It is a base class. Polymorphism is known at run-time through virtual polymorphism

Constructor & Destructor Documentation

PPC_KO_wrapper()

template<SOLVER solver, K_IMP k_imp, VALID_ERR_RET valid_err_ret, CV_STRAT cv_strat, CV_ERR_EVAL cv_err_eval>

template<typename STOR_OBJ>

PPC_KO_wrapper< solver, k_imp, valid_err_ret, cv_strat, cv_err_eval >::PPC_KO_wrapper ( STOR_OBJ && data, int number_threads )

inline

Constructor.

Parameters

data	matrix storing fts
number_threads	number of threads for OMP

Universal constructor: move semantic used to optimazing handling big size objects

Member Function Documentation

call_ko()

template<SOLVER solver, K_IMP k_imp, VALID_ERR_RET valid_err_ret, CV_STRAT cv_strat, CV_ERR_EVAL cv_err_eval>

virtual void PPC_KO_wrapper< solver, k_imp, valid_err_ret, cv_strat, cv_err_eval >::call_ko ( )

pure virtual

Virtual method to call the correct PPCKO version at runtime.

Implemented in PPC_KO_wrapper_cv_alpha< solver, k_imp, valid_err_ret, cv_strat, cv_err_eval >, PPC_KO_wrapper_cv_alpha_k< solver, k_imp, valid_err_ret, cv_strat, cv_err_eval >, PPC_KO_wrapper_cv_k< solver, k_imp, valid_err_ret, cv_strat, cv_err_eval >, and PPC_KO_wrapper_no_cv< solver, k_imp, valid_err_ret, cv_strat, cv_err_eval >.

data()

template<SOLVER solver, K_IMP k_imp, VALID_ERR_RET valid_err_ret, CV_STRAT cv_strat, CV_ERR_EVAL cv_err_eval>

KO_Traits::StoringMatrix PPC_KO_wrapper< solver, k_imp, valid_err_ret, cv_strat, cv_err_eval >::data ( ) const

inline

Getter for the data matrix.

Returns

the private m_data

number_threads()

template<SOLVER solver, K_IMP k_imp, VALID_ERR_RET valid_err_ret, CV_STRAT cv_strat, CV_ERR_EVAL cv_err_eval>

int PPC_KO_wrapper< solver, k_imp, valid_err_ret, cv_strat, cv_err_eval >::number_threads ( ) const

inline

Getter for the number of threads for OMP.

Returns

the private m_number_threads

results() [1/2]

template<SOLVER solver, K_IMP k_imp, VALID_ERR_RET valid_err_ret, CV_STRAT cv_strat, CV_ERR_EVAL cv_err_eval>

results_t< valid_err_ret > & PPC_KO_wrapper< solver, k_imp, valid_err_ret, cv_strat, cv_err_eval >::results ( )

inline

Setter for the results.

Returns

the private m_results (not-const)

results() [2/2]

template<SOLVER solver, K_IMP k_imp, VALID_ERR_RET valid_err_ret, CV_STRAT cv_strat, CV_ERR_EVAL cv_err_eval>

results_t< valid_err_ret > PPC_KO_wrapper< solver, k_imp, valid_err_ret, cv_strat, cv_err_eval >::results ( ) const

inline

Getter for the results.

Returns

the private m_results

---

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

• src/PPC_KO_wrapper.hpp