Flood::NewtonMethod Class Reference
#include <NewtonMethod.h>
Public Member Functions | |
| NewtonMethod (ObjectiveFunctional *) | |
| Vector< double > | calculate_training_direction (const Vector< double > &, const Matrix< double > &) |
| Vector< double > | calculate_gradient_descent_training_direction (const Vector< double > &) |
| void | train (void) |
| void | set_reserve_all_training_history (bool) |
| void | resize_training_history (int) |
| std::string | get_training_history_XML (bool) |
| std::string | to_XML (bool) |
| void | load (const char *) |
Detailed Description
This concrete class represents the Newton method training algorithm for an objective functional of a multilayer perceptron.Definition at line 31 of file NewtonMethod.h.
Member Function Documentation
| std::string Flood::NewtonMethod::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.
| void Flood::NewtonMethod::load | ( | const char * | filename | ) | [virtual] |
This method loads a gradient descent object from a XML-type file. Please mind about the file format, wich is specified in the User's Guide.
- Parameters:
-
filename Name of training algorithm XML-type file.
Reimplemented from Flood::TrainingAlgorithm.
| void Flood::NewtonMethod::resize_training_history | ( | int | new_size | ) | [virtual] |
This method resizes all the default training history vectors.
- Parameters:
-
new_size Size vectors containing the training history variables.
Reimplemented from Flood::TrainingAlgorithm.
| void Flood::NewtonMethod::set_reserve_all_training_history | ( | bool | new_reserve_all_training_history | ) | [virtual] |
This method makes the training history of all variables to be reseved or not in memory.
This method makes the training history of all default variables to reseved or not in memory. Reserving all the training history is memory expensive.
- Parameters:
-
new_reserve_all_training_history True if the training history of all variables is to be reserved, false otherwise.
Reimplemented from Flood::TrainingAlgorithm.
| std::string Flood::NewtonMethod::to_XML | ( | bool | show_declaration | ) | [virtual] |
This method returns a default string representation in XML-type format of the training algorithm object. This containts the training operators, the training parameters, stopping criteria and other stuff.
- Parameters:
-
show_declaration True if an XML-type declaration is to be included at the beginning.
Reimplemented from Flood::TrainingAlgorithm.
| void Flood::NewtonMethod::train | ( | void | ) | [virtual] |
This method trains a multilayer perceptron which has a objective functional associated.
Implements Flood::TrainingAlgorithm.
The documentation for this class was generated from the following file:
