Flood::MinkowskiError Class Reference

#include <MinkowskiError.h>

Inheritance diagram for Flood::MinkowskiError:

List of all members.

Public Member Functions

MinkowskiError (void)

MinkowskiError (MultilayerPerceptron *)

MinkowskiError (InputTargetDataSet *)

MinkowskiError (MultilayerPerceptron *, InputTargetDataSet *)

virtual ~MinkowskiError (void)

InputTargetDataSet * get_input_target_data_set_pointer (void)

double get_Minkowski_parameter (void)

void set (void)

void set (MultilayerPerceptron *)

void set (InputTargetDataSet *)

void set (MultilayerPerceptron *, InputTargetDataSet *)

void set_input_target_data_set_pointer (InputTargetDataSet *)

void set_Minkowski_parameter (double)

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 > &, 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)

std::string to_XML (bool)

void load (const char *)

Detailed Description

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

Definition at line 29 of file MinkowskiError.h.

Constructor & Destructor Documentation

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

Default constructor. It creates Minkowski 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.

Minkowski parameter = 1.5.

Definition at line 41 of file MinkowskiError.cpp.

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

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

Minkowski parameter = 1.5.

Parameters:

new_multilayer_perceptron_pointer

Pointer to a multilayer perceptron object.

Definition at line 59 of file MinkowskiError.cpp.

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

Multilayer perceptron constructor. It creates a Minkowski error objective functional object not associated to any multilayer perceptron but to be measured on an input-target data set object. It also initializes all the rest of class members to their default values.

Minkowski parameter = 1.5.

Parameters:

new_input_target_data_set_pointer

Pointer to an input-target data set object.

Definition at line 78 of file MinkowskiError.cpp.

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

General constructor. It creates a Minkowski 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.

Minkowski parameter = 1.5.

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 98 of file MinkowskiError.cpp.

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

Destructor.

Definition at line 111 of file MinkowskiError.cpp.

Member Function Documentation

Vector< Vector< double > > Flood::MinkowskiError::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 595 of file MinkowskiError.cpp.

Vector< double > Flood::MinkowskiError::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 728 of file MinkowskiError.cpp.

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

This method returns the objective functional value of a multilayer perceptron according to the Minkowski error on the training instances of an input-target data set.

Implements Flood::ObjectiveFunctional.

Definition at line 243 of file MinkowskiError.cpp.

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

This method returns the the Minkowski error function gradient of a multilayer perceptron on an input-target data set. It uses the error back-propagation method.

Reimplemented from Flood::ObjectiveFunctional.

Definition at line 931 of file MinkowskiError.cpp.

Vector< double > Flood::MinkowskiError::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 431 of file MinkowskiError.cpp.

Vector< double > Flood::MinkowskiError::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 852 of file MinkowskiError.cpp.

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

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

Reimplemented from Flood::ObjectiveFunctional.

Definition at line 341 of file MinkowskiError.cpp.

InputTargetDataSet* Flood::MinkowskiError::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 61 of file MinkowskiError.h.

double Flood::MinkowskiError::get_Minkowski_parameter ( void )

This method returns the Minkowski exponent value used to calculate the error.

Definition at line 123 of file MinkowskiError.cpp.

void Flood::MinkowskiError::load ( const char * filename ) [virtual]

This method loads the members of a Minkowski error object from a XML-type file.

Parameters:

filename

Name of XML-type Minkowski error file.

Reimplemented from Flood::ObjectiveFunctional.

Definition at line 1086 of file MinkowskiError.cpp.

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

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

Minkowski parameter = 1.5.

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 192 of file MinkowskiError.cpp.

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

This method sets the multilayer perceptron pointer to null, and sets a new input-target data set pointer. It also initializes all the rest of class members to their default values:

Minkowski parameter = 1.5.

Parameters:

new_input_target_data_set_pointer

Pointer to an input-target data set object.

Definition at line 173 of file MinkowskiError.cpp.

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

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

Minkowski parameter = 1.5.

Parameters:

new_multilayer_perceptron_pointer

Pointer to a multilayer perceptron object.

Definition at line 155 of file MinkowskiError.cpp.

void Flood::MinkowskiError::set ( void )

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

Minkowski parameter = 1.5.

Definition at line 137 of file MinkowskiError.cpp.

void Flood::MinkowskiError::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 206 of file MinkowskiError.cpp.

void Flood::MinkowskiError::set_Minkowski_parameter ( double new_Minkowski_parameter )

This method sets a new Minkowski exponent value to be used in order to calculate the error. The Minkowski R-value must be comprised between 1 and 2.

Parameters:

new_Minkowski_parameter

Minkowski exponent value.

Definition at line 218 of file MinkowskiError.cpp.

std::string Flood::MinkowskiError::to_XML ( bool show_declaration ) [virtual]

This method returns a string representation of this object in a XML-type format.

Parameters:

show_declaration

True if an XML-type declaration is to be included at the beginning.

Reimplemented from Flood::ObjectiveFunctional.

Definition at line 1022 of file MinkowskiError.cpp.

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


Public Member Functions
	MinkowskiError (void)
	MinkowskiError (MultilayerPerceptron *)
	MinkowskiError (InputTargetDataSet *)
	MinkowskiError (MultilayerPerceptron , InputTargetDataSet )
virtual	~MinkowskiError (void)
InputTargetDataSet *	get_input_target_data_set_pointer (void)
double	get_Minkowski_parameter (void)
void	set (void)
void	set (MultilayerPerceptron *)
void	set (InputTargetDataSet *)
void	set (MultilayerPerceptron , InputTargetDataSet )
void	set_input_target_data_set_pointer (InputTargetDataSet *)
void	set_Minkowski_parameter (double)
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 > &, 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)
std::string	to_XML (bool)
void	load (const char *)