OpenNN::InverseProblemTesting Class Reference

#include <inverse_problem_testing.h>

List of all members.

Public Member Functions

 InverseProblemTesting (void)
 InverseProblemTesting (NeuralNetwork *)
 InverseProblemTesting (DataSet *)
 InverseProblemTesting (NeuralNetwork *, DataSet *, MathematicalModel *)
 InverseProblemTesting (TiXmlElement *)
virtual ~InverseProblemTesting (void)
NeuralNetworkget_neural_network_pointer (void) const
DataSetget_data_set_pointer (void) const
MathematicalModelget_mathematical_model_pointer (void) const
const bool & get_display (void) const
void set_neural_network_pointer (NeuralNetwork *)
void set_data_set_pointer (DataSet *)
void set_mathematical_model_pointer (MathematicalModel *)
void set_display (const bool &)
void set_default (void)
std::string to_string (void) const
virtual TiXmlElement * to_XML (void) const
virtual void from_XML (TiXmlElement *)


Detailed Description

This class contains methods for testing inverse problems.

Definition at line 37 of file inverse_problem_testing.h.


Constructor & Destructor Documentation

OpenNN::InverseProblemTesting::InverseProblemTesting ( void   )  [explicit]

Default constructor. It creates a inverse problem testing object not associated to a neural network, a data set or a mathematical model.

Definition at line 35 of file inverse_problem_testing.cpp.

OpenNN::InverseProblemTesting::InverseProblemTesting ( NeuralNetwork new_neural_network_pointer  )  [explicit]

Neural network constructor. It creates a inverse problem testing object associated to a neural network but not to a a data set or a mathematical model.

Parameters:
new_neural_network_pointer Pointer to a neural network object.

Definition at line 50 of file inverse_problem_testing.cpp.

OpenNN::InverseProblemTesting::InverseProblemTesting ( DataSet new_data_set_pointer  )  [explicit]

Data set constructor. It creates a inverse problem testing object associated to a data set, but not to a neural network or a mathematical model.

Parameters:
new_data_set_pointer Pointer to a data set object.

Definition at line 65 of file inverse_problem_testing.cpp.

OpenNN::InverseProblemTesting::InverseProblemTesting ( NeuralNetwork new_neural_network_pointer,
DataSet new_data_set_pointer,
MathematicalModel new_mathematical_model_pointer 
) [explicit]

Neural network, mathematical model and data set constructor. It creates a inverse problem testing object associated to a neural network, a mathematical model and a data set.

Parameters:
new_neural_network_pointer Pointer to a neural network object.
new_mathematical_model_pointer Pointer to a mathematical model object.
new_data_set_pointer Pointer to a data set object.

Definition at line 83 of file inverse_problem_testing.cpp.

OpenNN::InverseProblemTesting::InverseProblemTesting ( TiXmlElement *  inverse_problem_testing_element  )  [explicit]

XML constructor. It creates an inverse problem testing neither associated to a neural network, nor to a mathematical model, nor to a data set. It also loads the members of this object from a TinyXML element.

Parameters:
inverse_problem_testing_element XML element which contains the member data.

Definition at line 99 of file inverse_problem_testing.cpp.

OpenNN::InverseProblemTesting::~InverseProblemTesting ( void   )  [virtual]

Destructor. This destructor does not delete any pointer.

Definition at line 115 of file inverse_problem_testing.cpp.


Member Function Documentation

NeuralNetwork * OpenNN::InverseProblemTesting::get_neural_network_pointer ( void   )  const

This method returns a pointer to the neural network which is to be tested.

Definition at line 126 of file inverse_problem_testing.cpp.

DataSet * OpenNN::InverseProblemTesting::get_data_set_pointer ( void   )  const

This method returns a pointer to the data set object on which the neural network is tested.

Definition at line 146 of file inverse_problem_testing.cpp.

MathematicalModel * OpenNN::InverseProblemTesting::get_mathematical_model_pointer ( void   )  const

This method returns a pointer to the mathematical model object on which the neural network is tested.

Definition at line 136 of file inverse_problem_testing.cpp.

const bool & OpenNN::InverseProblemTesting::get_display ( void   )  const

This method returns true if messages from this class can be displayed on the screen, or false if messages from this class can't be displayed on the screen.

Definition at line 157 of file inverse_problem_testing.cpp.

void OpenNN::InverseProblemTesting::set_neural_network_pointer ( NeuralNetwork new_neural_network_pointer  ) 

This method sets a new neural network to be tested.

Parameters:
new_neural_network_pointer Pointer to the neural network object to be tested.

Definition at line 168 of file inverse_problem_testing.cpp.

void OpenNN::InverseProblemTesting::set_data_set_pointer ( DataSet new_data_set_pointer  ) 

This method sets a new data set on which the neural network is to be tested.

Parameters:
new_data_set_pointer Pointer to the data set object used for testing.

Definition at line 179 of file inverse_problem_testing.cpp.

void OpenNN::InverseProblemTesting::set_mathematical_model_pointer ( MathematicalModel new_mathematical_model_pointer  ) 

This method sets a new mathematical model on which the neural network is to be tested.

Parameters:
new_mathematical_model_pointer Pointer to the mathematical model object used for testing.

Definition at line 190 of file inverse_problem_testing.cpp.

void OpenNN::InverseProblemTesting::set_display ( const bool &  new_display  ) 

This method sets a new display flag.

Parameters:
new_display Flag for displaying messages from this class or not.

Definition at line 201 of file inverse_problem_testing.cpp.

void OpenNN::InverseProblemTesting::set_default ( void   ) 

This method sets the default values from the inverse problem testing class:

  • Display: True.

Definition at line 214 of file inverse_problem_testing.cpp.

std::string OpenNN::InverseProblemTesting::to_string ( void   )  const

This method returns a string representation of the current inverse problem testing object.

Definition at line 224 of file inverse_problem_testing.cpp.

TiXmlElement * OpenNN::InverseProblemTesting::to_XML ( void   )  const [virtual]

This method serializes the inverse problem testing object into a XML element of the TinyXML library. See the OpenNN manual for more information about the format of this element.

Todo:

Definition at line 241 of file inverse_problem_testing.cpp.

void OpenNN::InverseProblemTesting::from_XML ( TiXmlElement *   )  [virtual]

Todo:

Definition at line 251 of file inverse_problem_testing.cpp.


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

Generated on Sun Aug 26 11:58:19 2012 for OpenNN by  doxygen 1.5.9