gp/src/problem.h

Go to the documentation of this file.

 
#if !defined(ULTRA_SRC_PROBLEM_H)
#define      ULTRA_SRC_PROBLEM_H
 
#include "kernel/problem.h"
#include "kernel/gp/src/dataframe.h"
#include "kernel/gp/src/multi_dataset.h"
 
#include <expected>
#include <filesystem>
#include <string>
#include <type_traits>
#include <vector>
 
namespace ultra
{

enum class symbol_init : unsigned
{
  disabled   =  0,  
  variables  =  1,  
  attributes =  2,  
  ephemerals =  4,  
  functions  =  8,  
  all        = 15,  
};

template<> struct is_bitmask_enum<symbol_init> : std::true_type {};

constexpr symbol_init def_terminal_init =
  symbol_init::variables | symbol_init::attributes;
 
}  // namespace ultra
 
namespace ultra::src
{

class problem : public ultra::problem
{
public:
  // ---- Member types ----
  enum class readiness_error
  {
    invalid_problem,             
    empty_training_set,          
    insufficient_terminals,      
    missing_functions,           
    missing_category_terminals   
  };
 
  // ---- Constructors ----
  problem() = default;
 
  explicit problem(dataframe, symbol_init = def_terminal_init);
  explicit problem(const std::filesystem::path &,
                   const dataframe::params & = {});
  explicit problem(std::istream &, const dataframe::params & = {});
  problem(ultra::problem &&, dataframe);
 
  // ---- Information about the problem ----
  [[nodiscard]] bool classification() const noexcept { return classes() > 1; }
 
  [[nodiscard]] std::size_t categories() const noexcept;
  [[nodiscard]] std::size_t classes() const noexcept;
  [[nodiscard]] std::size_t variables() const noexcept;
 
  [[nodiscard]] std::expected<void, readiness_error> ready() const;
 
  // ---- Misc ----
  void setup_symbols(symbol_init = symbol_init::all);
  void setup_terminals(symbol_init = def_terminal_init);
  [[nodiscard]] bool is_valid() const override;
 
  // ---- Public data members ----
  multi_dataset<dataframe> data;
 
private:
  // ---- Private support methods ----
  [[nodiscard]] bool compatible(const function::param_data_types &,
                                const std::vector<std::string> &) const;
};
 
}  // namespace ultra::src
 
#endif  // include guard