traits_ko.hpp

Go to the documentation of this file.

// Copyright (c) 2024 Andrea Enrico Franzoni (andreaenrico.franzoni@gmail.com)
//
// This file is part of PPCKO
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of PPCKO and associated documentation files (the PPCKO software), to deal
// PPCKO without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of PPCKO, and to permit persons to whom PPCKO is
// furnished to do so, subject to the following conditions:
//
// PPCKO IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH PPCKO OR THE USE OR OTHER DEALINGS IN
// PPCKO.
 
#ifndef KO_TRAITS_HPP
#define KO_TRAITS_HPP
 
#include <Eigen/Dense>
#include <tuple>
#include <vector>
#include <array>
#include <variant>
#include <type_traits>
#include <cmath>
#include <string>

 
 

struct KO_Traits
{
public:
  
  using StoringMatrix = Eigen::MatrixXd;  
  
  using StoringVector = Eigen::VectorXd;  
  
  using StoringArray  = Eigen::ArrayXd;   
 
};
 

struct CV_algo
{
  static constexpr std::string CV1 = "NoCV";        
  static constexpr std::string CV2 = "CV_alpha";    
  static constexpr std::string CV3 = "CV_k";        
  static constexpr std::string CV4 = "CV";          
};
 

enum SOLVER
{
  ex_solver  = 0,      
  gep_solver = 1,      
};
 

enum K_IMP
{
  NO  = 0,     
  YES = 1,     
};
 

enum VALID_ERR_RET
{
  NO_err   = 0,     
  YES_err  = 1,     
};
 

enum CV_STRAT
{
  AUGMENTING_WINDOW = 0,  
};
 

enum CV_ERR_EVAL
{
  MSE = 0,  
};
 

using valid_err_cv_1_t = std::vector<double>;
using valid_err_cv_2_t = std::vector<std::vector<double>>;
using valid_err_variant = std::variant<valid_err_cv_1_t,valid_err_cv_2_t>;
 

using results_err_t = std::tuple<KO_Traits::StoringVector, double, int, std::vector<double>, std::vector<double>, KO_Traits::StoringMatrix, KO_Traits::StoringMatrix, std::vector<std::array<double,2>>, KO_Traits::StoringArray, valid_err_variant>; 
using results_no_err_t = std::tuple<KO_Traits::StoringVector, double, int, std::vector<double>, std::vector<double>, KO_Traits::StoringMatrix, KO_Traits::StoringMatrix, std::vector<std::array<double,2>>, KO_Traits::StoringArray>; 

template <VALID_ERR_RET valid_err_ret>
using results_t = typename std::conditional<valid_err_ret,results_err_t,results_no_err_t>::type;  //if errors are returned: the tuple will have one more element
 
 
 
#endif /*KO_TRAITS_HPP*/