parameters.h

Go to the documentation of this file.

/*
-------------------------------------------------------------------------
   This file is part of BayesOpt, an efficient C++ library for 
   Bayesian optimization.

   Copyright (C) 2011-2015 Ruben Martinez-Cantin <rmcantin@unizar.es>
 
   BayesOpt is free software: you can redistribute it and/or modify it 
   under the terms of the GNU Affero General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.

   BayesOpt is distributed in the hope that it will be useful, but 
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU Affero General Public License for more details.

   You should have received a copy of the GNU Affero General Public License
   along with BayesOpt.  If not, see <http://www.gnu.org/licenses/>.
------------------------------------------------------------------------
*/


#ifndef __BOPT_PARAMETERS_H__
#define __BOPT_PARAMETERS_H__

#include <string.h>

/* WINDOWS DLLs stuff */
#if defined (BAYESOPT_DLL) && (defined(_WIN32) || defined(__WIN32__)) && !defined(__LCC__)
  #if defined(bayesopt_EXPORTS)
    #define  BAYESOPT_API __declspec(dllexport)
  #else
    #define  BAYESOPT_API __declspec(dllimport)
  #endif /* MyLibrary_EXPORTS */
#else /* defined (_WIN32) */
 #define BAYESOPT_API
#endif

#ifdef __cplusplus
extern "C" {
#endif 

  /*-----------------------------------------------------------*/
  /* Configuration parameters                                  */
  /*-----------------------------------------------------------*/
  typedef enum {
    L_FIXED,
    L_EMPIRICAL,
    L_DISCRETE,
    L_MCMC,
    L_ERROR = -1
  } learning_type;

  typedef enum {
    SC_MTL,
    SC_ML,
    SC_MAP,
    SC_LOOCV,
    SC_ERROR = -1
  } score_type;


  typedef struct {
    char*  name;                 
    double hp_mean[128];         
    double hp_std[128];          
    size_t n_hp;                 
  } kernel_parameters;

  typedef struct {
    char* name;                  
    double coef_mean[128];       
    double coef_std[128];        
    size_t n_coef;               
  } mean_parameters;

  typedef struct {
    size_t n_iterations;         
    size_t n_inner_iterations;   
    size_t n_init_samples;       
    size_t n_iter_relearn;       
    size_t init_method;          
    int random_seed;             
    int verbose_level;           
    char* log_filename;          
    size_t load_save_flag;       
    char* load_filename;          
    char* save_filename;          
    char* surr_name;             
    double sigma_s;              
    double noise;                
    double alpha;                
    double beta;                 
    score_type sc_type;          
    learning_type l_type;        
    int l_all;                   
    double epsilon;              
    size_t force_jump;           
    kernel_parameters kernel;    
    mean_parameters mean;        
    char* crit_name;             
    double crit_params[128];     
    size_t n_crit_params;        
  } bopt_params;
                            
  /*-----------------------------------------------------------*/
  /* These functions are added to simplify wrapping code       */
  /*-----------------------------------------------------------*/
  BAYESOPT_API learning_type str2learn(const char* name);
  BAYESOPT_API const char* learn2str(learning_type name);

  BAYESOPT_API score_type str2score(const char* name);
  BAYESOPT_API const char* score2str(score_type name);

  BAYESOPT_API void set_kernel(bopt_params* params, const char* name);
  BAYESOPT_API void set_mean(bopt_params* params, const char* name);
  BAYESOPT_API void set_criteria(bopt_params* params, const char* name);
  BAYESOPT_API void set_surrogate(bopt_params* params, const char* name);
  BAYESOPT_API void set_log_file(bopt_params* params, const char* name);
  BAYESOPT_API void set_load_file(bopt_params* params, const char* name);
  BAYESOPT_API void set_save_file(bopt_params* params, const char* name);
  BAYESOPT_API void set_learning(bopt_params* params, const char* name);
  BAYESOPT_API void set_score(bopt_params* params, const char* name);

  BAYESOPT_API bopt_params initialize_parameters_to_default(void);

#ifdef __cplusplus
}
#endif 


#endif