ne_sup_sa.h

Go to the documentation of this file.

/*===========================================================================
 NetEvo Foundation Library
 Copyright (C) 2009, 2010 Thomas E. Gorochowski <tgorochowski@me.com>
 Bristol Centre for Complexity Sciences, University of Bristol, Bristol, UK
 ---------------------------------------------------------------------------- 
 NetEvo is a computing framework designed to allow researchers to investigate 
 evolutionary aspects of dynamical complex networks. By providing tools to 
 easily integrate each of these factors in a coherent way, it is hoped a 
 greater understanding can be gained of key attributes and features displayed 
 by complex systems.
 
 NetEvo is open-source software released under the Open Source Initiative 
 (OSI) approved Non-Profit Open Software License ("Non-Profit OSL") 3.0. 
 Detailed information about this licence can be found in the COPYING file 
 included as part of the source distribution.
 
 This library 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.
 ============================================================================*/
#ifndef NE_SUP_SA_H
#define NE_SUP_SA_H


#include "ne_std.h"
#include "ne_sys.h"
#include "ne_mut.h"
#include "ne_per.h"
#include "ne_sim.h"

typedef ne_err_code_t ne_sup_sa_analysis_fn_t (ne_sys_t *sys, ne_dyn_vec_t *dyn, int iteration,
                                    double temp, double Q, ne_bool_t forceOutput);

typedef struct {
   int                      initialTrials;           
   double                   tempReduce;              
   int                      mainTrials;              
   int                      acceptTrials;            
   int                      acceptRunsNoChange;      
   double                   minTemp;                 
   int                      maxIterations;           
   double                 (*initialTempFn) (double); 
   ne_per_t                *QFn;                     
   ne_mut_t                *mutationFn;              
   ne_sim_fn_t             *simFn;                   
   void                    *simParams;               
   ne_dyn_vec_t            *initCond;                
   ne_sup_sa_analysis_fn_t *analysisFn;              
   FILE                    *evoFile;                 
} ne_sup_sa_params_t;

typedef struct {
   double Q1;            
   double Q2;            
   double dQ;            
   double a;             
   ne_dyn_vec_t *curDyn; 
} ne_sup_sa_trail_results_t;

ne_sup_sa_params_t * ne_sup_sa_params_alloc (int initialTrials, double tempReduce, int mainTrails,
                                    int acceptTrials, int acceptRunsNoChange, double minTemp,
                                    int maxIterations, double (*initialTempFn) (double),
                                    ne_per_t *QFn, ne_mut_t *mutationFn, ne_sim_fn_t *simFn,
                                  void *simParams, ne_dyn_vec_t *initCond, 
                                    ne_sup_sa_analysis_fn_t *analysisFn, FILE *evoFile);

void ne_sup_sa_params_free (ne_sup_sa_params_t *params);

ne_sys_t * ne_sup_sa_run (ne_sys_t *sys, ne_sup_sa_params_t* params);

ne_sys_t * ne_sup_sa_trail (ne_sys_t *sys, double T, ne_sup_sa_trail_results_t *results, 
                 ne_sup_sa_params_t *params);

double ne_sup_sa_simulate (ne_sys_t *sys, ne_sup_sa_params_t* params);

double ne_sup_sa_int_temp_basic (double qMax);


#endif /* NE_SUP_SA_H */