Flood::RandomSearch Class Reference

#include <RandomSearch.h>

Inheritance diagram for Flood::RandomSearch:

List of all members.

Public Member Functions
	RandomSearch (ObjectiveFunctional *)
	RandomSearch (void)
virtual	~RandomSearch (void)
double	get_training_rate_reduction_factor (void)
int	get_training_rate_reduction_period (void)
bool	get_reserve_potential_parameters_history (void)
bool	get_reserve_potential_parameters_norm_history (void)
bool	get_reserve_potential_evaluation_history (void)
Vector< Vector< double > >	get_potential_parameters_history (void)
Vector< double >	get_potential_parameters_norm_history (void)
Vector< double >	get_potential_evaluation_history (void)
void	set_default (void)
void	set_training_rate_reduction_factor (double)
void	set_training_rate_reduction_period (int)
void	set_reserve_potential_parameters_history (bool)
void	set_reserve_potential_parameters_norm_history (bool)
void	set_reserve_potential_evaluation_history (bool)
void	set_potential_parameters_history (const Vector< Vector< double > > &)
void	set_potential_parameters_norm_history (const Vector< double > &)
void	set_potential_evaluation_history (const Vector< double > &)
Vector< double >	calculate_training_direction (void)
void	train (void)
void	resize_training_history (int)
void	set_reserve_all_training_history (bool)
std::string	get_training_history_XML (bool)
std::string	to_XML (bool)
void	load (const char *)

---

Detailed Description

This concrete class represents a random search training algorithm for an objective functional of a multilayer perceptron.

Definition at line 28 of file RandomSearch.h.

---

Constructor & Destructor Documentation

Flood::RandomSearch::RandomSearch

(

ObjectiveFunctional *

new_objective_functional_pointer

)

[explicit]

General constructor. It creates a random search training algorithm object associated to an objective functional object. It also initializes the class members to their default values.

Parameters:

new_objective_functional_pointer

Pointer to an objective functional object.

Definition at line 41 of file RandomSearch.cpp.

Flood::RandomSearch::RandomSearch

(

void

)

[explicit]

Default constructor. It creates a random search training algorithm object not associated to any objective functional object. It also initializes the class members to their default values.

Definition at line 54 of file RandomSearch.cpp.

Flood::RandomSearch::~RandomSearch

(

void

)

[virtual]

Destructor.

Definition at line 64 of file RandomSearch.cpp.

---

Member Function Documentation

Vector< double > Flood::RandomSearch::get_potential_evaluation_history

(

void

)

This method returns the history of evaluation values, which is a vector.

Definition at line 144 of file RandomSearch.cpp.

Vector< Vector< double > > Flood::RandomSearch::get_potential_parameters_history

(

void

)

This method returns the history of potential parameters, which is a vector of vectors.

Definition at line 124 of file RandomSearch.cpp.

Vector< double > Flood::RandomSearch::get_potential_parameters_norm_history

(

void

)

This method returns the history of potential parameters norm values, which is a vector.

Definition at line 134 of file RandomSearch.cpp.

bool Flood::RandomSearch::get_reserve_potential_evaluation_history

(

void

)

This method returns true if the potential evaluation history is to be reserved, and false otherwise.

Definition at line 114 of file RandomSearch.cpp.

bool Flood::RandomSearch::get_reserve_potential_parameters_history

(

void

)

This method returns true if the potential parameters history is to be reserved, and false otherwise.

Definition at line 94 of file RandomSearch.cpp.

bool Flood::RandomSearch::get_reserve_potential_parameters_norm_history

(

void

)

This method returns true if the potential parameters norm history is to be reserved, and false otherwise.

Definition at line 104 of file RandomSearch.cpp.

std::string Flood::RandomSearch::get_training_history_XML

(

bool

show_declaration

)

[virtual]

This method returns a string with the history of the training process in XML-type format. Only that training history variables which have been reserved are included here.

Parameters:

show_declaration

True if an XML-type declaration is to be included at the beginning.

Reimplemented from Flood::TrainingAlgorithm.

Definition at line 626 of file RandomSearch.cpp.

double Flood::RandomSearch::get_training_rate_reduction_factor

(

void

)

This method returns the reducing factor for the training rate.

Definition at line 74 of file RandomSearch.cpp.

int Flood::RandomSearch::get_training_rate_reduction_period

(

void

)

This method returns the reducing period for the training rate.

Definition at line 84 of file RandomSearch.cpp.

void Flood::RandomSearch::load

(

const char *

filename

)

[virtual]

This method loads a random search object from a data file. Please mind about the file format, wich is specified in the User's Guide.

Parameters:

filename

Filename.

Reimplemented from Flood::TrainingAlgorithm.

Definition at line 803 of file RandomSearch.cpp.

void Flood::RandomSearch::resize_training_history

(

int

new_size

)

[virtual]

This method resizes the vectors or matrices containing training history information to a new size:

• Elapsed time history vector.
• Free parameters history matrix.
• Free parameters norm history vector.
• Evaluation history vector.

Parameters:

new_size

Size of training history.

Reimplemented from Flood::TrainingAlgorithm.

Definition at line 571 of file RandomSearch.cpp.

void Flood::RandomSearch::set_default

(

void

)

[virtual]

This method sets all the random search object members to their default values:

• Training rate reduction factor: 0.9
• Training rate reduction period: 10
• Warning parameters norm: 1.0e6
• Error parameters norm: 1.0e9
• Evaluation goal: -1.0e99
• Maximum time: 1.0e6
• Maximum epochs number: 100
• Reserve potential parameters history: False
• Reserve potential parameters norm history: False
• Reserve evaluation history: False.
• Display: True
• Display period: 10

Reimplemented from Flood::TrainingAlgorithm.

Definition at line 168 of file RandomSearch.cpp.

void Flood::RandomSearch::set_reserve_all_training_history

(

bool

new_reserve_all_training_history

)

[virtual]

This method makes the training history of all variables to reseved or not in memory.

Parameters:

new_reserve_all_training_history

True if the training history of all variables is to be reserved, false otherwise.

Reimplemented from Flood::TrainingAlgorithm.

Definition at line 277 of file RandomSearch.cpp.

std::string Flood::RandomSearch::to_XML

(

bool

show_declaration

)

[virtual]

This method prints to the screen the training parameters, the stopping criteria and other user stuff concerning the random search object.

Parameters:

show_declaration

True if an XML-type declaration is to be included, false otherwise.

Reimplemented from Flood::TrainingAlgorithm.

Definition at line 708 of file RandomSearch.cpp.

void Flood::RandomSearch::train

(

void

)

[virtual]

This method trains a multilayer perceptron with an associated objective function according to the random search training algorithm. Training occurs according to the training parameters.

Implements Flood::TrainingAlgorithm.

Definition at line 325 of file RandomSearch.cpp.

---

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

• RandomSearch.h
• RandomSearch.cpp