OpenNN::TimeSeriesPredictionTesting Class Reference

#include <time_series_prediction_testing.h>

List of all members.

Public Member Functions

 TimeSeriesPredictionTesting (void)
 TimeSeriesPredictionTesting (NeuralNetwork *)
 TimeSeriesPredictionTesting (DataSet *)
 TimeSeriesPredictionTesting (NeuralNetwork *, DataSet *)
 TimeSeriesPredictionTesting (TiXmlElement *)
virtual ~TimeSeriesPredictionTesting (void)
NeuralNetworkget_neural_network_pointer (void) const
DataSetget_data_set_pointer (void) const
const bool & get_display (void) const
void set_neural_network_pointer (NeuralNetwork *)
void set_data_set_pointer (DataSet *)
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 time series prediction problems.

Definition at line 33 of file time_series_prediction_testing.h.


Constructor & Destructor Documentation

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

Default constructor. It creates a time series prediction testing object neither associated to a neural network nor to a data set.

Definition at line 36 of file time_series_prediction_testing.cpp.

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

Neural network constructor. It creates a time series prediction testing object associated to a neural network but not to a data set.

Parameters:
new_neural_network_pointer Pointer to a neural network object.

Definition at line 50 of file time_series_prediction_testing.cpp.

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

Data set constructor. It creates a time series prediction testing object associated to a data set but not to a neural network.

Parameters:
new_data_set_pointer Pointer to a data set object.

Definition at line 64 of file time_series_prediction_testing.cpp.

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

General constructor. It creates a time series prediction testing object associated to a neural network and a data set objects.

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

Definition at line 79 of file time_series_prediction_testing.cpp.

OpenNN::TimeSeriesPredictionTesting::TimeSeriesPredictionTesting ( TiXmlElement *  time_series_prediction_testing_element  )  [explicit]

XML constructor. It creates a time series prediction testing object neither associated to a neural network nor to a data set objects. It also loads the members of this object from a TinyXML element.

Parameters:
time_series_prediction_testing_element XML element which contains the member data.

Definition at line 94 of file time_series_prediction_testing.cpp.

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

Destructor. It does not delete any pointer.

Definition at line 110 of file time_series_prediction_testing.cpp.


Member Function Documentation

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

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

Definition at line 121 of file time_series_prediction_testing.cpp.

DataSet * OpenNN::TimeSeriesPredictionTesting::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 131 of file time_series_prediction_testing.cpp.

const bool & OpenNN::TimeSeriesPredictionTesting::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 142 of file time_series_prediction_testing.cpp.

void OpenNN::TimeSeriesPredictionTesting::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 153 of file time_series_prediction_testing.cpp.

void OpenNN::TimeSeriesPredictionTesting::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 164 of file time_series_prediction_testing.cpp.

void OpenNN::TimeSeriesPredictionTesting::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 175 of file time_series_prediction_testing.cpp.

void OpenNN::TimeSeriesPredictionTesting::set_default ( void   ) 

This method sets the default values from the function regression testing class:

  • Display: True.

Definition at line 188 of file time_series_prediction_testing.cpp.

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

This method returns a string representation of this time series prediction testing object.

Definition at line 198 of file time_series_prediction_testing.cpp.

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

This method serializes the time series prediction testing object into a XML element of the TinyXML library.

Definition at line 213 of file time_series_prediction_testing.cpp.

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

This method deserializes a TinyXML element into this time series prediction testing object.

Todo:

Definition at line 225 of file time_series_prediction_testing.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