Flood::RootMeanSquaredError Class Reference

#include <RootMeanSquaredError.h>

Inheritance diagram for Flood::RootMeanSquaredError:

List of all members.

Public Member Functions

RootMeanSquaredError (void)

RootMeanSquaredError (MultilayerPerceptron *)

RootMeanSquaredError (InputTargetDataSet *)

RootMeanSquaredError (MultilayerPerceptron *, InputTargetDataSet *)

virtual ~RootMeanSquaredError (void)

InputTargetDataSet * get_input_target_data_set_pointer (void)

void set (void)

void set (MultilayerPerceptron *)

void set (InputTargetDataSet *)

void set (MultilayerPerceptron *, InputTargetDataSet *)

void set_input_target_data_set_pointer (InputTargetDataSet *)

double calculate_objective (void)

double calculate_validation_error (void)

Vector< double > calculate_output_errors (const Vector< Vector< double > > &, const Vector< double > &)

Vector< Vector< double > > calculate_hidden_errors (const Vector< Vector< double > > &, const Vector< double > &)

Vector< double > calculate_hidden_layers_error_gradient (const Vector< double > &input, const Vector< Vector< double > > &, const Vector< Vector< double > > &)

Vector< double > calculate_output_layer_error_gradient (const Vector< Vector< double > > &, const Vector< double > &)

Vector< double > calculate_objective_gradient (void)

Detailed Description

This class represents the root mean squared error objective functional of a multilayer perceptron. This objective functional is used in data modeling problems.

Definition at line 29 of file RootMeanSquaredError.h.

Constructor & Destructor Documentation

Flood::RootMeanSquaredError::RootMeanSquaredError ( void ) [explicit]

Default constructor. It creates a root mean squared error objective functional object not associated to any multilayer perceptron and not measured on any input-target data set. It also initializes all the rest of class members to their default values.

Definition at line 38 of file RootMeanSquaredError.cpp.

Flood::RootMeanSquaredError::RootMeanSquaredError ( MultilayerPerceptron * new_multilayer_perceptron_pointer ) [explicit]

Multilayer perceptron constructor. It creates a root mean squared error associated to a multilayer perceptron object but not to an input-target data set object. It also initializes all the rest of class members to their default values.

Parameters:

new_multilayer_perceptron_pointer

Pointer to a multilayer perceptron object.

Definition at line 51 of file RootMeanSquaredError.cpp.

Flood::RootMeanSquaredError::RootMeanSquaredError ( InputTargetDataSet * new_input_target_data_set_pointer ) [explicit]

Input-target data set constructor. It creates a root mean squared error associated to an input-target data set object but not to a multilayer perceptron object. It also initializes all the rest of class members to their default values.

Parameters:

new_input_target_data_set_pointer

Pointer to an input-target data set object.

Definition at line 65 of file RootMeanSquaredError.cpp.

Flood::RootMeanSquaredError::RootMeanSquaredError	(	MultilayerPerceptron *	new_multilayer_perceptron_pointer,
		InputTargetDataSet *	new_input_target_data_set_pointer
	)			`[explicit]`

General constructor. It creates a root mean squared error objective functional object associated to a multilayer perceptron and measured on an input-target data set. It also initializes all the rest of class members to their default values.

Parameters:

	new_multilayer_perceptron_pointer	Pointer to a multilayer perceptron object.
	new_input_target_data_set_pointer	Pointer to an input-target data set object.

Definition at line 80 of file RootMeanSquaredError.cpp.

Flood::RootMeanSquaredError::~RootMeanSquaredError ( void ) [virtual]

Destructor.

Definition at line 92 of file RootMeanSquaredError.cpp.

Member Function Documentation

Vector< Vector< double > > Flood::RootMeanSquaredError::calculate_hidden_errors	(	const Vector< Vector< double > > &	forward_propagation_derivative,
		const Vector< double > &	output_errors
	)

This method returns the hidden errors to be used in the back-propagation algorithm for calculating the objective gradient.

Parameters:

	forward_propagation_derivative	Forward propagation derivative.
	output_errors	Output errors.

Definition at line 479 of file RootMeanSquaredError.cpp.

Vector< double > Flood::RootMeanSquaredError::calculate_hidden_layers_error_gradient	(	const Vector< double > &	input,
		const Vector< Vector< double > > &	forward_propagation_derivative,
		const Vector< Vector< double > > &	hidden_errors
	)

This method returns the hidden layers error gradient to be used in the back-propagation algorithm for calculating the objective gradient.

Parameters:

	input	Input values.
	forward_propagation_derivative	Forward propagation derivative.
	hidden_errors	Hidden errors.

Definition at line 613 of file RootMeanSquaredError.cpp.

double Flood::RootMeanSquaredError::calculate_objective ( void ) [virtual]

This method returns the evaluation value of a multilayer perceptron according to the root mean squared error on the training instances of an input-target data set.

Implements Flood::ObjectiveFunctional.

Definition at line 172 of file RootMeanSquaredError.cpp.

Vector< double > Flood::RootMeanSquaredError::calculate_objective_gradient ( void ) [virtual]

This method calculates the gradient the root mean squared error funcion by means of the back-propagation algorithm.

Reimplemented from Flood::ObjectiveFunctional.

Definition at line 253 of file RootMeanSquaredError.cpp.

Vector< double > Flood::RootMeanSquaredError::calculate_output_errors	(	const Vector< Vector< double > > &	forward_propagation_derivative,
		const Vector< double > &	target
	)

This method returns the output errors to be used in the back-propagation algorithm for calculating the objective gradient.

Parameters:

	forward_propagation_derivative	Forward propagation derivative.
	target	Target values.

Definition at line 346 of file RootMeanSquaredError.cpp.

Vector< double > Flood::RootMeanSquaredError::calculate_output_layer_error_gradient	(	const Vector< Vector< double > > &	forward_propagation_derivative,
		const Vector< double > &	output_errors
	)

This method returns the output layers error gradient to be used in the back-propagation algorithm for calculating the objective gradient.

Parameters:

	forward_propagation_derivative	Forward propagation derivative.
	output_errors	Output errors.

Definition at line 737 of file RootMeanSquaredError.cpp.

double Flood::RootMeanSquaredError::calculate_validation_error ( void ) [virtual]

This method returns the root mean squared error of the multilayer perceptron measured on the validation instances of the input-target data set.

Reimplemented from Flood::ObjectiveFunctional.

Definition at line 815 of file RootMeanSquaredError.cpp.

InputTargetDataSet* Flood::RootMeanSquaredError::get_input_target_data_set_pointer ( void ) [inline]

This method returns a pointer to the input-target data set object on which the objective functional is measured.

Definition at line 62 of file RootMeanSquaredError.h.

void Flood::RootMeanSquaredError::set	(	MultilayerPerceptron *	new_multilayer_perceptron_pointer,
		InputTargetDataSet *	new_input_target_data_set_pointer
	)

This method sets a new multilayer perceptron pointer and a new input-target data set pointer. The rest of class members are initialized to their default values.

Parameters:

	new_multilayer_perceptron_pointer	Pointer to a multilayer perceptron object.
	new_input_target_data_set_pointer	Pointer to an input-target data set object.

Definition at line 147 of file RootMeanSquaredError.cpp.

void Flood::RootMeanSquaredError::set ( InputTargetDataSet * new_input_target_data_set_pointer )

This method sets a new input-target data set pointer. It also sets the multilayer perceptron pointer to NULL. The rest of class members are initialized to their default values.

Parameters:

new_input_target_data_set_pointer

Pointer to an input-target data set object.

Definition at line 132 of file RootMeanSquaredError.cpp.

void Flood::RootMeanSquaredError::set ( MultilayerPerceptron * new_multilayer_perceptron_pointer )

This method sets a new multilayer perceptron pointer. It also sets the input-target data set pointer to NULL. The rest of class members are initialized to their default values.

Parameters:

new_multilayer_perceptron_pointer

Pointer to a multilayer perceptron object.

Definition at line 118 of file RootMeanSquaredError.cpp.

void Flood::RootMeanSquaredError::set ( void )

This method sets the multilayer perceptron and the input-target data set pointers to NULL. It also initializes all the rest of class members to their default values.

Definition at line 104 of file RootMeanSquaredError.cpp.

void Flood::RootMeanSquaredError::set_input_target_data_set_pointer ( InputTargetDataSet * new_input_target_data_set_pointer )

This method sets a pointer to an input-data set object on which the objective functional is to be measured.

Parameters:

new_input_target_data_set_pointer

Pointer to an input-target data set object.

Definition at line 161 of file RootMeanSquaredError.cpp.

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


Public Member Functions
	RootMeanSquaredError (void)
	RootMeanSquaredError (MultilayerPerceptron *)
	RootMeanSquaredError (InputTargetDataSet *)
	RootMeanSquaredError (MultilayerPerceptron , InputTargetDataSet )
virtual	~RootMeanSquaredError (void)
InputTargetDataSet *	get_input_target_data_set_pointer (void)
void	set (void)
void	set (MultilayerPerceptron *)
void	set (InputTargetDataSet *)
void	set (MultilayerPerceptron , InputTargetDataSet )
void	set_input_target_data_set_pointer (InputTargetDataSet *)
double	calculate_objective (void)
double	calculate_validation_error (void)
Vector< double >	calculate_output_errors (const Vector< Vector< double > > &, const Vector< double > &)
Vector< Vector< double > >	calculate_hidden_errors (const Vector< Vector< double > > &, const Vector< double > &)
Vector< double >	calculate_hidden_layers_error_gradient (const Vector< double > &input, const Vector< Vector< double > > &, const Vector< Vector< double > > &)
Vector< double >	calculate_output_layer_error_gradient (const Vector< Vector< double > > &, const Vector< double > &)
Vector< double >	calculate_objective_gradient (void)