OpenNN::TestingAnalysis Class Reference

#include <testing_analysis.h>

List of all members.

Public Member Functions

 TestingAnalysis (void)
 TestingAnalysis (NeuralNetwork *)
 TestingAnalysis (MathematicalModel *)
 TestingAnalysis (DataSet *)
 TestingAnalysis (NeuralNetwork *, DataSet *)
 TestingAnalysis (NeuralNetwork *, MathematicalModel *)
 TestingAnalysis (NeuralNetwork *, DataSet *, MathematicalModel *)
 TestingAnalysis (TiXmlElement *)
 TestingAnalysis (const std::string &)
virtual ~TestingAnalysis (void)
NeuralNetworkget_neural_network_pointer (void) const
DataSetget_data_set_pointer (void) const
MathematicalModelget_mathematical_model_pointer (void) const
FunctionRegressionTestingget_function_regression_testing_pointer (void) const
PatternRecognitionTestingget_pattern_recognition_testing_pointer (void) const
TimeSeriesPredictionTestingget_time_series_prediction_testing_pointer (void) const
InverseProblemTestingget_inverse_problem_testing_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_function_regression_testing_pointer (FunctionRegressionTesting *)
void set_pattern_recognition_testing_pointer (PatternRecognitionTesting *)
void set_time_series_prediction_testing_pointer (TimeSeriesPredictionTesting *)
void set_inverse_problem_testing_pointer (InverseProblemTesting *)
void set_display (const bool &)
void set_default (void)
void construct_function_regression_testing (void)
void construct_pattern_recognition_testing (void)
void construct_time_series_prediction_testing (void)
void construct_inverse_problem_testing (void)
void destruct_function_regression_testing (void)
void destruct_pattern_recognition_testing (void)
void destruct_time_series_prediction_testing (void)
void destruct_inverse_problem_testing (void)
std::string to_string (void) const
void print (void) const
virtual TiXmlElement * to_XML (void) const
virtual void from_XML (TiXmlElement *)
void save (const std::string &) const
void load (const std::string &)


Detailed Description

This class contains tools for testing neural networks in different learning tasks. In particular, it is composed by four different objects:

Definition at line 47 of file testing_analysis.h.


Constructor & Destructor Documentation

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

Default constructor. It creates a testing analysis object neither associated to a neural network nor to a mathematical model or a data set. By default, it constructs the function regression testing object.

Definition at line 37 of file testing_analysis.cpp.

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

Neural network constructor. It creates a testing analysis object associated to a neural network but not to a mathematical model or a data set. By default, it constructs the function regression testing object.

Parameters:
new_neural_network_pointer Pointer to a neural network object.

Definition at line 60 of file testing_analysis.cpp.

OpenNN::TestingAnalysis::TestingAnalysis ( MathematicalModel new_mathematical_model_pointer  )  [explicit]

Mathematical mmodel constructor. It creates a testing analysis object not associated to a neural network, not associated to a data set, and associated to a mathematical model. By default, it constructs the inverse problem testing object.

Parameters:
new_mathematical_model_pointer Pointer to a mathematical model object.

Definition at line 82 of file testing_analysis.cpp.

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

Data set constructor. It creates a testing analysis object not associated to a neural network, associated to a data set and not associated to a mathematical model. By default, it constructs the function regression testing object.

Parameters:
new_data_set_pointer Pointer to a data set object.

Definition at line 104 of file testing_analysis.cpp.

OpenNN::TestingAnalysis::TestingAnalysis ( NeuralNetwork new_neural_network_pointer,
DataSet new_data_set_pointer 
) [explicit]

Neural network and data set constructor. It creates a testing analysis object associated to a neural network and to a data set. By default, it constructs the function regression testing object.

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

Definition at line 150 of file testing_analysis.cpp.

OpenNN::TestingAnalysis::TestingAnalysis ( NeuralNetwork new_neural_network_pointer,
MathematicalModel new_mathematical_model_pointer 
) [explicit]

Neural network and mathematical model constructor. It creates a testing analysis object associated to a neural network and to a mathematical model, but not to a data set. By default, it constructs the inverse problem testing object.

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

Definition at line 127 of file testing_analysis.cpp.

OpenNN::TestingAnalysis::TestingAnalysis ( 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 testing analysis object associated to a neural network, a mathematical model and a data set. By default, it constructs the inverse problem testing object.

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 174 of file testing_analysis.cpp.

OpenNN::TestingAnalysis::TestingAnalysis ( TiXmlElement *  testing_analysis_element  )  [explicit]

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

Parameters:
testing_analysis_element Pointer to a XML element containing the member data.

Definition at line 196 of file testing_analysis.cpp.

OpenNN::TestingAnalysis::TestingAnalysis ( const std::string &  filename  )  [explicit]

File constructor. It creates a testing analysis object neither associated to a neural network nor to a mathematical model or a data set. It also loads the members of this object from XML file.

Parameters:
filename Name of testing analysis XML file.

Definition at line 218 of file testing_analysis.cpp.

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

Destructor. It deletes the function regression testing, pattern recognition testing, time series prediction testing and inverse problem testing objects.

Definition at line 237 of file testing_analysis.cpp.


Member Function Documentation

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

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

Definition at line 252 of file testing_analysis.cpp.

DataSet * OpenNN::TestingAnalysis::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 262 of file testing_analysis.cpp.

MathematicalModel * OpenNN::TestingAnalysis::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 272 of file testing_analysis.cpp.

FunctionRegressionTesting * OpenNN::TestingAnalysis::get_function_regression_testing_pointer ( void   )  const

This method returns a pointer to the function regression testing object composing this testing analysis object.

Definition at line 282 of file testing_analysis.cpp.

PatternRecognitionTesting * OpenNN::TestingAnalysis::get_pattern_recognition_testing_pointer ( void   )  const

This method returns a pointer to the pattern recognition testing object composing this testing analysis object.

Definition at line 292 of file testing_analysis.cpp.

TimeSeriesPredictionTesting * OpenNN::TestingAnalysis::get_time_series_prediction_testing_pointer ( void   )  const

This method returns a pointer to the time series prediction testing object composing this testing analysis object.

Definition at line 302 of file testing_analysis.cpp.

InverseProblemTesting * OpenNN::TestingAnalysis::get_inverse_problem_testing_pointer ( void   )  const

This method returns a pointer to the inverse problem testing object composing this testing analysis object.

Definition at line 312 of file testing_analysis.cpp.

const bool & OpenNN::TestingAnalysis::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 323 of file testing_analysis.cpp.

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

This method sets a new neural network object to be tested.

Parameters:
new_neural_network_pointer Pointer to a neural network object.

Definition at line 347 of file testing_analysis.cpp.

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

This method sets a new data set to be used for validating the quality of a trained neural network.

Parameters:
new_data_set_pointer Pointer to a data set object.

Definition at line 369 of file testing_analysis.cpp.

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

This method sets a mathematical model to be used for validating the quality of a trained neural network.

Parameters:
new_mathematical_model_pointer Pointer to a mathematical model object.

Definition at line 358 of file testing_analysis.cpp.

void OpenNN::TestingAnalysis::set_function_regression_testing_pointer ( FunctionRegressionTesting new_function_regression_testing_pointer  ) 

This method sets a new function regression testing into the testing analysis. Note that this pointer will be deleted by the destructor.

Parameters:
new_function_regression_testing_pointer Pointer to a function regression testing object.

Definition at line 381 of file testing_analysis.cpp.

void OpenNN::TestingAnalysis::set_pattern_recognition_testing_pointer ( PatternRecognitionTesting new_pattern_recognition_testing_pointer  ) 

This method sets a new pattern recognition testing into the testing analysis. Note that this pointer will be deleted by the destructor.

Parameters:
new_pattern_recognition_testing_pointer Pointer to a pattern recognition testing object.

Definition at line 393 of file testing_analysis.cpp.

void OpenNN::TestingAnalysis::set_time_series_prediction_testing_pointer ( TimeSeriesPredictionTesting new_time_series_prediction_testing_pointer  ) 

This method sets a new time series prediction testing into the testing analysis. Note that this pointer will be deleted by the destructor.

Parameters:
new_time_series_prediction_testing_pointer Pointer to a time series prediction testing object.

Definition at line 405 of file testing_analysis.cpp.

void OpenNN::TestingAnalysis::set_inverse_problem_testing_pointer ( InverseProblemTesting new_inverse_problem_testing_pointer  ) 

This method sets a new inverse problem testing into the testing analysis. Note that this pointer will be deleted by the destructor.

Parameters:
new_inverse_problem_testing_pointer Pointer to an inverse problem testing object.

Definition at line 417 of file testing_analysis.cpp.

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

This method sets a new display value. If it is set to true messages from this class are to be displayed on the screen; if it is set to false messages from this class are not to be displayed on the screen.

Parameters:
new_display Display value.

Definition at line 430 of file testing_analysis.cpp.

void OpenNN::TestingAnalysis::set_default ( void   ) 

This method sets some default values to the testing analysis object:

  • Display: True.

Definition at line 336 of file testing_analysis.cpp.

void OpenNN::TestingAnalysis::construct_function_regression_testing ( void   ) 

This method constructs the function regression testing object inside the testing analysis object. It sets the actual neural network and data set to the new object.

Definition at line 441 of file testing_analysis.cpp.

void OpenNN::TestingAnalysis::construct_pattern_recognition_testing ( void   ) 

This method constructs the pattern recognition testing object inside the testing analysis object. It sets the actual neural network and data set to the new object.

Definition at line 455 of file testing_analysis.cpp.

void OpenNN::TestingAnalysis::construct_time_series_prediction_testing ( void   ) 

This method constructs the time series prediction testing object inside the testing analysis object. It sets the actual neural network and data set to the new object.

Definition at line 469 of file testing_analysis.cpp.

void OpenNN::TestingAnalysis::construct_inverse_problem_testing ( void   ) 

This method constructs the function regression testing object inside the testing analysis object. It sets the actual neural network, data set and mathematical model to the new object.

Definition at line 483 of file testing_analysis.cpp.

void OpenNN::TestingAnalysis::destruct_function_regression_testing ( void   ) 

This method deletes the function regression testing object composing the testing analysis object.

Definition at line 496 of file testing_analysis.cpp.

void OpenNN::TestingAnalysis::destruct_pattern_recognition_testing ( void   ) 

This method deletes the pattern recognition testing object composing the testing analysis object.

Definition at line 508 of file testing_analysis.cpp.

void OpenNN::TestingAnalysis::destruct_time_series_prediction_testing ( void   ) 

This method deletes the time series prediction testing object composing the testing analysis object.

Definition at line 520 of file testing_analysis.cpp.

void OpenNN::TestingAnalysis::destruct_inverse_problem_testing ( void   ) 

This method deletes the inverse problem testing object composing the testing analysis object.

Definition at line 532 of file testing_analysis.cpp.

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

This method returns a string representation of the testing analysis object.

Definition at line 544 of file testing_analysis.cpp.

void OpenNN::TestingAnalysis::print ( void   )  const

This method prints to the standard output the string representation of this testing analysis object.

Definition at line 579 of file testing_analysis.cpp.

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

This method serializes the testing analysis 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 591 of file testing_analysis.cpp.

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

Todo:

Definition at line 601 of file testing_analysis.cpp.

void OpenNN::TestingAnalysis::save ( const std::string &   )  const

Todo:

Definition at line 609 of file testing_analysis.cpp.

void OpenNN::TestingAnalysis::load ( const std::string &   ) 

Todo:

Definition at line 618 of file testing_analysis.cpp.


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

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