OpenNN::IndependentParameters Class Reference

#include <independent_parameters.h>

List of all members.

Public Types

enum  ScalingMethod { MeanStandardDeviation, MinimumMaximum }

Public Member Functions

 IndependentParameters (void)
 IndependentParameters (const unsigned int &)
 IndependentParameters (const IndependentParameters &)
virtual ~IndependentParameters (void)
IndependentParametersoperator= (const IndependentParameters &)
bool operator== (const IndependentParameters &) const
int count_parameters_number (void) const
const Vector< double > & get_parameters (void) const
double get_parameter (const unsigned int &) const
const Vector< std::string > & get_names (void) const
const std::string & get_name (const unsigned int &) const
const Vector< std::string > & get_units (void) const
const std::string & get_unit (const unsigned int &) const
const Vector< std::string > & get_descriptions (void) const
const std::string & get_description (const unsigned int &) const
const Vector< double > & get_minimums (void) const
double get_minimum (const unsigned int &) const
const Vector< double > & get_maximums (void) const
double get_maximum (const unsigned int &) const
const Vector< double > & get_means (void) const
double get_mean (const unsigned int &) const
const Vector< double > & get_standard_deviations (void) const
double get_standard_deviation (const unsigned int &) const
const ScalingMethodget_scaling_method (void) const
std::string write_scaling_method (void) const
const bool & get_scaling_flag (void) const
const Vector< double > & get_lower_bounds (void) const
double get_lower_bound (const unsigned int &) const
const Vector< double > & get_upper_bounds (void) const
double get_upper_bound (const unsigned int &) const
Vector< Vector< double > * > get_bounds (void)
bool get_bounding_flag (void) const
const bool & get_display (void) const
void set (void)
void set (const unsigned int &)
void set (const Vector< double > &)
void set (const IndependentParameters &)
virtual void set_default (void)
void set_parameters_number (const unsigned int &)
void set_parameters (const Vector< double > &)
void set_parameter (const unsigned int &, const double &)
void set_names (const Vector< std::string > &)
void set_name (const unsigned int &, const std::string &)
void set_units (const Vector< std::string > &)
void set_unit (const unsigned int &, const std::string &)
void set_descriptions (const Vector< std::string > &)
void set_description (const unsigned int &, const std::string &)
void set_minimums (const Vector< double > &)
void set_minimum (const unsigned int &, const double &)
void set_maximums (const Vector< double > &)
void set_maximum (const unsigned int &, const double &)
void set_means (const Vector< double > &)
void set_mean (const unsigned int &, const double &)
void set_standard_deviations (const Vector< double > &)
void set_standard_deviation (const unsigned int &, const double &)
void set_scaling_method (const ScalingMethod &)
void set_scaling_method (const std::string &)
void set_scaling_flag (const bool &)
void set_lower_bounds (void)
void set_lower_bounds (const Vector< double > &)
void set_lower_bound (const unsigned int &, const double &)
void set_upper_bounds (void)
void set_upper_bounds (const Vector< double > &)
void set_upper_bound (const unsigned int &, const double &)
void set_bounds (void)
void set_bounds (const Vector< Vector< double > > &)
void set_bounding_flag (const bool &)
void set_display (const bool &)
bool is_empty (void) const
void initialize_random (void)
void initialize_parameters (const double &)
void initialize_parameters_uniform (void)
void initialize_parameters_uniform (const double &, const double &)
void initialize_parameters_uniform (const Vector< double > &, const Vector< double > &)
void initialize_parameters_uniform (const Vector< Vector< double > > &)
void initialize_parameters_normal (void)
void initialize_parameters_normal (const double &, const double &)
void initialize_parameters_normal (const Vector< double > &, const Vector< double > &)
void initialize_parameters_normal (const Vector< Vector< double > > &)
Vector< double > calculate_scaled_parameters (void) const
void unscale_parameters (const Vector< double > &)
void bound_parameters (void)
void bound_parameter (const unsigned int &)
Vector< Vector< std::string > > arrange_information (void)
Vector< Vector< double > > arrange_statistics (void)
Vector< Vector< double > > arrange_minimums_maximums (void)
Vector< Vector< double > > arrange_means_standard_deviations (void)
void set_statistics (const Vector< Vector< double > > &)
void set_minimums_maximums (const Vector< Vector< double > > &)
void set_means_standard_deviations (const Vector< Vector< double > > &)
std::string to_string (void) const
TiXmlElement * to_XML (void) const
void from_XML (TiXmlElement *)

Protected Attributes

Vector< double > parameters
Vector< std::string > names
Vector< std::string > units
Vector< std::string > descriptions
Vector< double > minimums
Vector< double > maximums
Vector< double > means
Vector< double > standard_deviations
Vector< double > lower_bounds
Vector< double > upper_bounds
ScalingMethod scaling_method
bool scaling_flag
bool bounding_flag
bool display_range_warning
bool display


Detailed Description

This class represents the concept of independent parameters. Independent parameters are set of free parameters which do not belong to any class of neuron. They can be used for many different purposes, including a turn arround for function optimization problems.

Definition at line 40 of file independent_parameters.h.


Member Enumeration Documentation

Enumeration of available methods for scaling and unscaling the independent parameters.

Definition at line 77 of file independent_parameters.h.


Constructor & Destructor Documentation

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

Default constructor. It creates a independent parameters object with zero parameters. This constructor also initializes the members of the object to their default values.

Definition at line 38 of file independent_parameters.cpp.

OpenNN::IndependentParameters::IndependentParameters ( const unsigned int &  new_parameters_number  )  [explicit]

Independent parameters constructor. It creates a independent parameters object with a given number of parameters. The independent parameters are initialized at random. This constructor also initializes the rest of class members to their default values.

Parameters:
new_parameters_number Number of independent parameters.

Definition at line 52 of file independent_parameters.cpp.

OpenNN::IndependentParameters::IndependentParameters ( const IndependentParameters other_independent_parameters  ) 

Copy constructor. It creates a copy of an existing independent parameters object.

Parameters:
other_independent_parameters Independent parameterse object to be copied.

Definition at line 65 of file independent_parameters.cpp.

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

Destructor. This destructor does not delete any pointer.

Definition at line 76 of file independent_parameters.cpp.


Member Function Documentation

IndependentParameters & OpenNN::IndependentParameters::operator= ( const IndependentParameters other_independent_parameters  ) 

Assignment operator. It assigns to this object the members of an existing independent parameters object.

Parameters:
other_independent_parameters Independent parameters object to be assigned.

Definition at line 87 of file independent_parameters.cpp.

bool OpenNN::IndependentParameters::operator== ( const IndependentParameters other_independent_parameters  )  const

Equal to operator. It compares this object with another object of the same class. It returns true if the members of the two objects have the same values, and false otherwise. @ param other_independent_parameters Independent parameters object to be compared with.

Definition at line 121 of file independent_parameters.cpp.

int OpenNN::IndependentParameters::count_parameters_number ( void   )  const [inline]

This method returns the number of parameters independent of the multilayer perceptron Independent parameters can be used in the context of neural netwotks for many purposes.

Definition at line 86 of file independent_parameters.h.

const Vector< double > & OpenNN::IndependentParameters::get_parameters ( void   )  const

This method returns the values of the independent parameters.

Definition at line 154 of file independent_parameters.cpp.

double OpenNN::IndependentParameters::get_parameter ( const unsigned int &  index  )  const

This method returns the value of a single independent parameter.

Parameters:
index Index of independent parameter.

Definition at line 165 of file independent_parameters.cpp.

const Vector< std::string > & OpenNN::IndependentParameters::get_names ( void   )  const

This method returns the names of the independent parameters. Such names are only used to give the user basic information about the problem at hand.

Definition at line 195 of file independent_parameters.cpp.

const std::string & OpenNN::IndependentParameters::get_name ( const unsigned int &  index  )  const

This method returns the name of a single independent parameter. Such name is only used to give the user basic information about the problem at hand.

Parameters:
index Index of independent parameter.

Definition at line 207 of file independent_parameters.cpp.

const Vector< std::string > & OpenNN::IndependentParameters::get_units ( void   )  const

This method returns the units of the independent parameters. Such units are only used to give the user basic information about the problem at hand.

Definition at line 237 of file independent_parameters.cpp.

const std::string & OpenNN::IndependentParameters::get_unit ( const unsigned int &  index  )  const

This method returns the unit of a single independent parameter. Such units are only used to give the user basic information about the problem at hand.

Parameters:
index Index of independent parameter.

Definition at line 249 of file independent_parameters.cpp.

const Vector< std::string > & OpenNN::IndependentParameters::get_descriptions ( void   )  const

This method returns the descriptions of the independent parameters. Such descriptions are only used to give the user basic information about the problem at hand.

Definition at line 279 of file independent_parameters.cpp.

const std::string & OpenNN::IndependentParameters::get_description ( const unsigned int &  index  )  const

This method returns the description of a single independent parameter. Such description is only used to give the user basic information about the problem at hand.

Parameters:
index Index of independent parameter.

Definition at line 291 of file independent_parameters.cpp.

const Vector< double > & OpenNN::IndependentParameters::get_minimums ( void   )  const

This method returns the minimum values of all the independent parameters. Such values are to be used for scaling and unscaling independent parameters with the minimum and maximum method.

Definition at line 343 of file independent_parameters.cpp.

double OpenNN::IndependentParameters::get_minimum ( const unsigned int &  index  )  const

This method returns the minimum value of a single independent parameter. Such value is to be used for scaling and unscaling that independent parameter with the minimum and maximum method.

Parameters:
index Index of independent parameter.

Definition at line 355 of file independent_parameters.cpp.

const Vector< double > & OpenNN::IndependentParameters::get_maximums ( void   )  const

This method returns the maximum values of all the independent parameters. Such values are to be used for scaling and unscaling independent parameters with the minimum and maximum method.

Definition at line 386 of file independent_parameters.cpp.

double OpenNN::IndependentParameters::get_maximum ( const unsigned int &  index  )  const

This method returns the maximum value of a single independent parameter. Such value is to be used for scaling and unscaling that independent parameter with the minimum and maximum method.

Parameters:
index Index of independent parameter.

Definition at line 398 of file independent_parameters.cpp.

const Vector< double > & OpenNN::IndependentParameters::get_means ( void   )  const

This method returns the mean values of all the independent parameters. Such values are to be used for scaling and unscaling independent parameters with the mean and standard deviation method.

Definition at line 428 of file independent_parameters.cpp.

double OpenNN::IndependentParameters::get_mean ( const unsigned int &  index  )  const

This method returns the mean value of a single independent parameter. Such a value is to be used for scaling and unscaling that parameter with the mean and standard deviation method.

Parameters:
index Index of independent parameter.

Definition at line 440 of file independent_parameters.cpp.

const Vector< double > & OpenNN::IndependentParameters::get_standard_deviations ( void   )  const

This method returns the standard deviation values of all the independent parameters. Such values are to be used for scaling and unscaling independent parameters with the mean and standard deviation method.

Definition at line 470 of file independent_parameters.cpp.

double OpenNN::IndependentParameters::get_standard_deviation ( const unsigned int &  index  )  const

This method returns the standard deviation value of a single independent parameter. Such a value is to be used for scaling and unscaling that parameter with the mean and standard deviation method.

Parameters:
index Index of independent parameter.

Definition at line 482 of file independent_parameters.cpp.

const IndependentParameters::ScalingMethod & OpenNN::IndependentParameters::get_scaling_method ( void   )  const

This method returns the method used for scaling and unscaling the independent parameters.

Definition at line 566 of file independent_parameters.cpp.

std::string OpenNN::IndependentParameters::write_scaling_method ( void   )  const

This method returns a string with the method used for scaling and unscaling the independent parameters.

Definition at line 576 of file independent_parameters.cpp.

const bool & OpenNN::IndependentParameters::get_scaling_flag ( void   )  const

This method returns the flag value for scaling and unscaling the independent parameters.

Definition at line 603 of file independent_parameters.cpp.

const Vector< double > & OpenNN::IndependentParameters::get_lower_bounds ( void   )  const

This method returns the lower bounds of all the independent parameters. These values are used to postprocess the independent parameters so that they are not less than the lower bounds.

Definition at line 614 of file independent_parameters.cpp.

double OpenNN::IndependentParameters::get_lower_bound ( const unsigned int &  index  )  const

This method returns the lower bound of a single independent parameter. These values are used to postprocess that independent parameter so that it is not less than the lower bound.

Parameters:
index Index of independent parameter.

Definition at line 626 of file independent_parameters.cpp.

const Vector< double > & OpenNN::IndependentParameters::get_upper_bounds ( void   )  const

This method returns the upper bounds of all the independent parameters. These values are used to postprocess the independent parameters so that they are not greater than the upper bounds.

Definition at line 656 of file independent_parameters.cpp.

double OpenNN::IndependentParameters::get_upper_bound ( const unsigned int &  index  )  const

This method returns the upper bound of a single independent parameter. These values are used to postprocess that independent parameter so that it is not greater than the upper bound.

Parameters:
index Index of independent parameter.

Definition at line 668 of file independent_parameters.cpp.

Vector< Vector< double > * > OpenNN::IndependentParameters::get_bounds ( void   ) 

This method returns the lower and upper bounds of all the independent parameters. The format is a vector of two pointers to real vectors. The first element contains the lower bounds of the independent parameters. The second element contains the upper bounds of the independent parameters. These values are used to postprocess the independent parameters so that they are neither less than the lower bounds nor greater than the upper bounds.

Definition at line 702 of file independent_parameters.cpp.

bool OpenNN::IndependentParameters::get_bounding_flag ( void   )  const

This method return the scaling flag for applying lower and upper bounds to the independent parameters.

Definition at line 717 of file independent_parameters.cpp.

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

This method returns true if messages from this class are to be displayed on the screen, or false if messages from this class are not to be displayed on the screen.

Definition at line 728 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set ( void   ) 

This method sets the number of independent parameters to be zero. It also sets the rest of members to their default values.

Definition at line 739 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set ( const unsigned int &  new_parameters_number  ) 

This method sets a new number of independent parameters. It also sets the rest of members to their default values.

Parameters:
new_parameters_number Number of independent parameters.

Definition at line 753 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set ( const Vector< double > &  new_parameters  ) 

This method sets new independent parameters. It also sets the rest of members to their default values.

Parameters:
new_parameters Vector of parameters.

Definition at line 767 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set ( const IndependentParameters other_independent_parameters  ) 

This method sets the members of this object to be the members of another object of the same class.

Parameters:
other_independent_parameters Object to be copied.

Definition at line 784 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_default ( void   )  [virtual]

This method sets the members of this object to their default values.

Definition at line 822 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_parameters_number ( const unsigned int &  new_parameters_number  ) 

This method sets a new number of independent parameters.

Parameters:
new_parameters_number Number of independent parameters.

Definition at line 839 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_parameters ( const Vector< double > &  new_parameters  ) 

This method sets new values for all the independent parameters.

Parameters:
new_parameters Independent parameters values.

Definition at line 868 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_parameter ( const unsigned int &  index,
const double &  new_parameter 
)

This method sets a new value for a single independent parameter.

Parameters:
index Index of independent parameter.
new_parameter Independent parameter value.

Definition at line 904 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_names ( const Vector< std::string > &  new_names  ) 

This method sets new names for the independent parameters. Such values are only used to give the user basic information on the problem at hand.

Parameters:
new_names New names for the independent parameters.

Definition at line 937 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_name ( const unsigned int &  index,
const std::string &  new_name 
)

This method sets a new name for a single independent parameter. Such a value is only used to give the user basic information on the problem at hand.

Parameters:
index Index of independent parameter.
new_name New name for the independent parameter of index i.

Definition at line 971 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_units ( const Vector< std::string > &  new_units  ) 

This method sets new units for the independent parameters. Such values are only used to give the user basic information on the problem at hand.

Parameters:
new_units New units for the independent parameters.

Definition at line 1009 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_unit ( const unsigned int &  index,
const std::string &  new_unit 
)

This method sets new units for a single independent parameter. Such a value is only used to give the user basic information on the problem at hand.

Parameters:
index Index of independent parameter.
new_unit New unit for the independent parameter with the previous index.

Definition at line 1043 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_descriptions ( const Vector< std::string > &  new_descriptions  ) 

This method sets new descriptions for the independent parameters. Such values are only used to give the user basic information on the problem at hand.

Parameters:
new_descriptions New description for the independent parameters.

Definition at line 1081 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_description ( const unsigned int &  index,
const std::string &  new_description 
)

This method sets a new description for a single independent parameter. Such a value is only used to give the user basic information on the problem at hand.

Parameters:
index Index of independent parameter.
new_description New description for the independent parameter with the previous index.

Definition at line 1113 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_minimums ( const Vector< double > &  new_minimums  ) 

This method sets the minimum values of all the independent parameters. These values are used for scaling and unscaling the independent parameters with the minimum and maximum method.

Parameters:
new_minimums New set of minimum values for the independent parameters.

Definition at line 1151 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_minimum ( const unsigned int &  index,
const double &  new_minimum 
)

This method sets a minimum value for a single independent parameter. Such a value is used for scaling and unscaling that independent parameter with the minimum and maximum method.

Parameters:
index Index of independent parameter.
new_minimum New minimum value for the independent parameter of index i.

Definition at line 1185 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_maximums ( const Vector< double > &  new_maximums  ) 

This method sets the maximum values of all the independent parameters. These values are used for scaling and unscaling the independent parameters with the minimum and maximum method.

Parameters:
new_maximums New set of maximum values for the independent parameters.

Definition at line 1223 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_maximum ( const unsigned int &  index,
const double &  new_maximum 
)

This method sets a maximum value for a single independent parameter. Such a value is used for scaling and unscaling that independent parameter with the minimum and maximum method.

Parameters:
index Index of independent parameter.
new_maximum New maximum value for the independent parameter with the previous index.

Definition at line 1257 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_means ( const Vector< double > &  new_means  ) 

This method sets the mean values of all the independent parameters. These values are used for scaling and unscaling the independent parameters with the mean and standard deviation method.

Parameters:
new_means New set of mean values for the independent parameters.

Definition at line 1297 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_mean ( const unsigned int &  index,
const double &  new_mean 
)

This method sets a new mean value for a single independent parameter. Such a value is used for scaling and unscaling the independent parameters with the mean and standard deviation method.

Parameters:
index Index of independent parameter.
new_mean New mean value for the independent parameter with the previous index.

Definition at line 1331 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_standard_deviations ( const Vector< double > &  new_standard_deviations  ) 

This method sets the standard deviation values of all the independent parameters. These values are used for scaling and unscaling the independent parameters with the mean and standard deviation method.

Parameters:
new_standard_deviations New set of standard deviation values for the independent parameters.

Definition at line 1373 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_standard_deviation ( const unsigned int &  index,
const double &  new_standard_deviation 
)

This method sets a new standard deviation value for a single independent parameter. Such a value is used for scaling and unscaling the independent parameters with the mean and standard deviation method.

Parameters:
index Index of independent parameter.
new_standard_deviation New standard deviation value for that independent parameter.

Definition at line 1407 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_scaling_method ( const ScalingMethod new_scaling_method  ) 

This method sets the method to be used for scaling and unscaling the independent parameters.

Parameters:
new_scaling_method New scaling and unscaling method for the independent parameters.

Definition at line 1620 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_scaling_method ( const std::string &  new_scaling_method  ) 

This method sets the method to be used for scaling and unscaling the independent parameters. The argument is a string containing the name of the method ("None", "MeanStandardDeviation" or "MinimumMaximum").

Parameters:
new_scaling_method Scaling and unscaling method for the independent parameters.

Definition at line 1632 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_scaling_flag ( const bool &  new_scaling_flag  ) 

This method sets the flag for scaling and unscaling the independent parameters.

Parameters:
new_scaling_flag True if the independent parameters are to be scaled and unscaled, and false otherwise.

Definition at line 1660 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_lower_bounds ( void   ) 

This method sets the lower bound of the independent parameters to an empty vector.

Definition at line 1670 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_lower_bounds ( const Vector< double > &  new_lower_bounds  ) 

This method sets the lower bound of all the independent parameters. These values are used for unscaling the independent parameters so that they are not less than the lower bounds.

Parameters:
new_lower_bounds New set of lower bounds for the independent parameters.

Definition at line 1684 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_lower_bound ( const unsigned int &  index,
const double &  new_lower_bound 
)

This method sets the lower bound of a single independent parameter. Such a value is used for unscaling that independent parameter so that it is not less than its lower bound.

Parameters:
index Index of independent parameter.
new_lower_bound New lower bound for that independent parameter.

Definition at line 1718 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_upper_bounds ( void   ) 

This method sets the vector of upper bounds for the independent parameters to have size zero.

Definition at line 1756 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_upper_bounds ( const Vector< double > &  new_upper_bounds  ) 

This method sets the upper bound of all the independent parameters. These values are used for unscaling the independent parameters so that they are not greater than the upper bounds.

Parameters:
new_upper_bounds New set of upper bounds for the independent parameters.

Definition at line 1771 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_upper_bound ( const unsigned int &  index,
const double &  new_upper_bound 
)

This method sets the upper bound of a single independent parameter. Such a value is used for unscaling that independent parameter so that it is not greater than its upper bound.

Parameters:
index Index of independent parameter.
new_upper_bound New upper bound for the independent parameter of index i.

Definition at line 1803 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_bounds ( void   ) 

This method sets the vectors of lower and upper bounds for the independent parameters to have size zero.

Definition at line 1832 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_bounds ( const Vector< Vector< double > > &  new_bounds  ) 

This method sets both the lower and the upper bounds of all the independent parameters. The format is a vector of two real vectors. The first element must contain the lower bound values values for the independent parameters. The second element must contain the upper bound values for the independent parameters. These values are used for unscaling the independent parameters so that they are neither less than the lower bounds nor greater than the upper bounds.

Parameters:
new_bounds New set of lower and upper bounds for the independent parameters.

Definition at line 1849 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_bounding_flag ( const bool &  new_bounding_flag  ) 

This method sets the flag for applying lower and upper bounds to the independent parameters.

Parameters:
new_bounding_flag True if the independent parameters are to be bounded, and false otherwise.

Definition at line 1895 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::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 1908 of file independent_parameters.cpp.

bool OpenNN::IndependentParameters::is_empty ( void   )  const

This method returns true if the number of parameters is zero, and false otherwise.

Definition at line 1918 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::initialize_random ( void   ) 

This method initializes all the membes of this object with random values. This is useful for testing purposes.

Definition at line 2094 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::initialize_parameters ( const double &  value  ) 

This method initializes the independent parameters with a given value.

Parameters:
value Initialization value.

Definition at line 1936 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::initialize_parameters_uniform ( void   ) 

This method initializes the independent parameters with values comprised between -1 and +1.

Definition at line 1951 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::initialize_parameters_uniform ( const double &  minimum,
const double &  maximum 
)

This method initializes the independent parameters at random with values comprised between a minimum and a maximum values.

Parameters:
minimum Minimum initialization value.
maximum Maximum initialization value.

Definition at line 1968 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::initialize_parameters_uniform ( const Vector< double > &  minimum,
const Vector< double > &  maximum 
)

This method initializes the independent parameters at random with values comprised between different minimum and maximum numbers for each independent parameter.

Parameters:
minimum Vector of minimum initialization values.
maximum Vector of maximum initialization values.

Definition at line 1986 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::initialize_parameters_uniform ( const Vector< Vector< double > > &  minimum_maximum  ) 

This method initializes the independent parameters at random values comprised between different minimum and maximum numbers for each independent parameter. All minimum and maximum values are given from a vector of two real vectors. The first element must contain the minimum inizizalization value for each independent parameter. The second element must contain the maximum inizizalization value for each independent parameter.

Parameters:
minimum_maximum Matrix of minimum and maximum initialization values.

Definition at line 2006 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::initialize_parameters_normal ( void   ) 

This method initializes the independent parameters with random values chosen from a normal distribution with mean 0 and standard deviation 1.

Definition at line 2022 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::initialize_parameters_normal ( const double &  mean,
const double &  standard_deviation 
)

This method initializes the independent parameters with random values chosen from a normal distribution with a given mean and a given standard deviation.

Parameters:
mean Mean of normal distribution.
standard_deviation Standard deviation of normal distribution.

Definition at line 2040 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::initialize_parameters_normal ( const Vector< double > &  mean,
const Vector< double > &  standard_deviation 
)

This method initializes the independent parameters with random values chosen from normal distributions with different mean and standard deviation for each independent parameter.

Parameters:
mean Vector of mean values.
standard_deviation Vector of standard deviation values.

Definition at line 2058 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::initialize_parameters_normal ( const Vector< Vector< double > > &  mean_standard_deviation  ) 

This method initializes the independent parameters with random values chosen from normal distributions with different mean and standard deviation for each independent parameter. All mean and standard deviation values are given from a vector of two real vectors. The first element must contain the mean value for each independent parameter. The second element must contain the standard deviation value for each independent parameter.

Parameters:
mean_standard_deviation Vector of mean and standard deviation vectors.

Definition at line 2078 of file independent_parameters.cpp.

Vector< double > OpenNN::IndependentParameters::calculate_scaled_parameters ( void   )  const

This method preprocesses the independendent parameters according to their scaling and unscaling method. This form of scaling is used prior when getting the vector of parameters.

Definition at line 2169 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::unscale_parameters ( const Vector< double > &  scaled_parameters  ) 

This method postprocesses the independendent parameters according to their scaling and unscaling method. This form of scaling is used when setting a new vector of parameters.

Definition at line 2251 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::bound_parameters ( void   ) 

This method makes the independent parameters to fall in the range defined by their lower and the upper bounds.

Definition at line 2329 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::bound_parameter ( const unsigned int &  index  ) 

This method makes a single independent parameter to fall in the range defined by its lower and the upper bounds.

Parameters:
index Index of independent parameters.

Definition at line 2356 of file independent_parameters.cpp.

Vector< Vector< std::string > > OpenNN::IndependentParameters::arrange_information ( void   ) 

This method returns all the available information about the independent parameters. The format is a vector of subvectors of size three:

  • Names of independent parameters.
  • Units of independent parameters.
  • Descriptions of independent parameters.

Definition at line 326 of file independent_parameters.cpp.

Vector< Vector< double > > OpenNN::IndependentParameters::arrange_statistics ( void   ) 

This method returns a vector of vectors with the basic statistics of the independent parameters (mean, standard deviation, minimum and maximum).

Definition at line 549 of file independent_parameters.cpp.

Vector< Vector< double > > OpenNN::IndependentParameters::arrange_minimums_maximums ( void   ) 

This method returns the minimum and maximum values of all the independent parameters. The format is a vector of two pointers to real vectors. The first element contains the minimum values of the independent parameters. The second element contains the maximum values of the independent parameters. Such values are to be used for scaling and unscaling independent parameters with the minimum and maximum method.

Definition at line 515 of file independent_parameters.cpp.

Vector< Vector< double > > OpenNN::IndependentParameters::arrange_means_standard_deviations ( void   ) 

This method returns the mean and the standard deviation values of all the independent parameters in a single matrix. The first row contains the mean values of the independent parameters. The second row contains the standard deviation values of the independent parameters. Such values are to be used for scaling and unscaling independent parameters with the mean and standard deviation method.

Definition at line 533 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_statistics ( const Vector< Vector< double > > &  new_statistics  ) 

This method sets all the statistics of the independent parameters. The format is a vector of four real vectors.

  • Mean of independent parameters.
  • Standard deviation of independent parameters.
  • Minimum of independent parameters.
  • Maximum of independent parameters.
Parameters:
new_statistics New statistics values for the independent parameters.

Definition at line 1584 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_minimums_maximums ( const Vector< Vector< double > > &  new_minimums_maximums  ) 

This method sets both the minimum and the values of all the independent parameters. The format is a vector of two real vectors. The first element must contain the minimum values values for the independent parameters. The second element must contain the maximum values for the independent parameters. These values are used for scaling and unscaling the independent parameters with the minimum and maximum method.

Parameters:
new_minimums_maximums New set of minimum and maximum values for the independent parameters.

Definition at line 1452 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::set_means_standard_deviations ( const Vector< Vector< double > > &  new_means_standard_deviations  ) 

This method sets both the mean and the standard deviation values of all the independent parameters. The format is a vector of two real vectors. The first element must contain the mean values values for the independent parameters. The second element must contain the standard deviation values for the independent parameters. These values are used for scaling and unscaling the independent parameters with the mean and standard deviation method.

Parameters:
new_means_standard_deviations New set of mean and standard deviation values for the independent parameters.

Definition at line 1516 of file independent_parameters.cpp.

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

This method returns a string representation of the current independent parameters object.

Definition at line 2390 of file independent_parameters.cpp.

TiXmlElement * OpenNN::IndependentParameters::to_XML ( void   )  const

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

Definition at line 2420 of file independent_parameters.cpp.

void OpenNN::IndependentParameters::from_XML ( TiXmlElement *  independent_parameters_element  ) 

This method deserializes a TinyXML element into this independent parameters object.

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

Definition at line 2640 of file independent_parameters.cpp.


Member Data Documentation

Independent parameters.

Definition at line 271 of file independent_parameters.h.

Vector<std::string> OpenNN::IndependentParameters::names [protected]

Name of independent parameters.

Definition at line 275 of file independent_parameters.h.

Vector<std::string> OpenNN::IndependentParameters::units [protected]

Units of independent parameters.

Definition at line 279 of file independent_parameters.h.

Description of independent parameters.

Definition at line 283 of file independent_parameters.h.

Minimum of independent parameters.

Definition at line 287 of file independent_parameters.h.

Maximum of independent parameters.

Definition at line 291 of file independent_parameters.h.

Mean of independent parameters.

Definition at line 295 of file independent_parameters.h.

Standard deviation of independent parameters.

Definition at line 299 of file independent_parameters.h.

Lower bound of independent parameters.

Definition at line 303 of file independent_parameters.h.

Upper bound of independent parameters.

Definition at line 307 of file independent_parameters.h.

Independent parameters scaling and unscaling method.

Definition at line 311 of file independent_parameters.h.

Flag for scaling and unscaling the independent parameters.

Definition at line 315 of file independent_parameters.h.

True if the independent parameters are to be bounded.

Definition at line 319 of file independent_parameters.h.

Display warnings when the the independent parameters fall outside their minimum-maximum range.

Definition at line 323 of file independent_parameters.h.

Display messages to screen.

Definition at line 327 of file independent_parameters.h.


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

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