Config Class Reference

Reads the configuration file (eg configuration.yml) and stores the configuration parameters as internal variables. More...

#include <config.h>

Static Private Attributes
static const char *	sFilename = "configuration.yml"
	Name of the configuration file. More...
std::string	dHPChain
	See getters. More...
int	dCycles
	See getters. More...
int	dNAnts
	See getters. More...
double	dAcoAlpha
	See getters. More...
double	dAcoBeta
	See getters. More...
double	dAcoEvaporation
	See getters. More...
int	dLSFrequency
	See getters. More...
int	dExchangedAnts
	See getters. More...
int	dRandSeed
	See getters. More...
std::string	dFilename
	See getters. More...
	Config ()
	The configuration file is read upon construction. More...
const std::string &	hp_chain () const
	HP chain of the protein to be predicted. More...
int	cycles () const
	Number of cycles that the ant colony must perform. More...
int	n_ants () const
	Number of ants in the colony. More...
double	aco_alpha () const
	Parameter alpha of the ACO probability calculation formula. More...
double	aco_beta () const
	Parameter beta of the ACO probability calculation formula. More...
double	aco_evaporation () const
	Evaporation rate of pheromones. More...
int	ls_frequency () const
	Local search frequency. More...
int	exchanged_ants () const
	Number of ants that MPI nodes should exchange at every cycle. More...
int	random_seed () const
	Random seed defined by the user. More...
const std::string &	filename () const
	Output filename for structural information of the protein. More...
void	set_hp_chain (std::string chain)
	See getters. More...
void	set_cycles (int cycles)
	See getters. More...
void	set_nants (int nants)
	See getters. More...

Detailed Description

Reads the configuration file (eg configuration.yml) and stores the configuration parameters as internal variables.

Constructor & Destructor Documentation

Config()

Config::Config

(

)

The configuration file is read upon construction.

Member Function Documentation

aco_alpha()

double Config::aco_alpha ( ) const

inline

Parameter alpha of the ACO probability calculation formula.

aco_beta()

double Config::aco_beta ( ) const

inline

Parameter beta of the ACO probability calculation formula.

aco_evaporation()

double Config::aco_evaporation ( ) const

inline

Evaporation rate of pheromones.

cycles()

int Config::cycles ( ) const

inline

Number of cycles that the ant colony must perform.

exchanged_ants()

int Config::exchanged_ants ( ) const

inline

Number of ants that MPI nodes should exchange at every cycle.

filename()

const std::string& Config::filename ( ) const

inline

Output filename for structural information of the protein.

hp_chain()

const std::string& Config::hp_chain ( ) const

inline

HP chain of the protein to be predicted.

ls_frequency()

int Config::ls_frequency ( ) const

inline

Local search frequency.

n_ants()

int Config::n_ants ( ) const

inline

Number of ants in the colony.

random_seed()

int Config::random_seed ( ) const

inline

Random seed defined by the user.

If the user-provided seed is negative, that means we should take a random seed, such as time(NULL).

set_cycles()

void Config::set_cycles ( int  cycles )

inline

See getters.

set_hp_chain()

void Config::set_hp_chain ( std::string  chain )

inline

See getters.

set_nants()

void Config::set_nants ( int  nants )

inline

See getters.

Member Data Documentation

dAcoAlpha

double Config::dAcoAlpha

private

See getters.

dAcoBeta

double Config::dAcoBeta

private

See getters.

dAcoEvaporation

double Config::dAcoEvaporation

private

See getters.

dCycles

int Config::dCycles

private

See getters.

dExchangedAnts

int Config::dExchangedAnts

private

See getters.

dFilename

std::string Config::dFilename

private

See getters.

dHPChain

std::string Config::dHPChain

private

See getters.

dLSFrequency

int Config::dLSFrequency

private

See getters.

dNAnts

int Config::dNAnts

private

See getters.

dRandSeed

int Config::dRandSeed

private

See getters.

sFilename

const char * Config::sFilename = "configuration.yml"

staticprivate

Name of the configuration file.

---

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

• src/config.h
• src/config.cc