OpenNN::InputsOutputsInformation Class Reference

#include <inputs_outputs_information.h>

List of all members.

Public Member Functions

 InputsOutputsInformation (void)
 InputsOutputsInformation (const unsigned int &, const unsigned int &)
 InputsOutputsInformation (TiXmlElement *)
 InputsOutputsInformation (const InputsOutputsInformation &)
virtual ~InputsOutputsInformation (void)
InputsOutputsInformationoperator= (const InputsOutputsInformation &)
bool operator== (const InputsOutputsInformation &) const
bool is_empty (void) const
unsigned int count_inputs_number (void) const
int count_outputs_number (void) const
const Vector< std::string > & get_inputs_name (void) const
const std::string & get_input_name (const unsigned int &) const
const Vector< std::string > & get_inputs_units (void) const
const std::string & get_input_units (const unsigned int &) const
const Vector< std::string > & get_inputs_description (void) const
const std::string & get_input_description (const unsigned int &) const
const Vector< std::string > & get_outputs_name (void) const
const std::string & get_output_name (const unsigned int &) const
const Vector< std::string > & get_outputs_units (void) const
const std::string & get_output_units (const unsigned int &) const
const Vector< std::string > & get_outputs_description (void) const
const std::string & get_output_description (const unsigned int &) const
Vector< Vector< std::string > * > get_information (void)
const bool & get_display (void) const
void set (void)
void set (const unsigned int &, const unsigned int &)
void set (const Vector< Vector< std::string > > &)
void set (const InputsOutputsInformation &)
void set_inputs_number (const unsigned int &)
void set_outputs_number (const unsigned int &)
virtual void set_default (void)
void set_inputs_name (const Vector< std::string > &)
void set_input_name (const unsigned int &, const std::string &)
void set_inputs_units (const Vector< std::string > &)
void set_input_units (const unsigned int &, const std::string &)
void set_inputs_description (const Vector< std::string > &)
void set_input_description (const unsigned int &, const std::string &)
void set_outputs_name (const Vector< std::string > &)
void set_output_name (const unsigned int &, const std::string &)
void set_outputs_units (const Vector< std::string > &)
void set_output_units (const unsigned int &, const std::string &)
void set_outputs_description (const Vector< std::string > &)
void set_output_description (const unsigned int &, const std::string &)
void set_information (const Vector< Vector< std::string > > &)
void set_display (const bool &)
void initialize_random (void)
Vector< std::string > write_default_inputs_name (void) const
Vector< std::string > write_default_outputs_name (void) const
std::string to_string (void) const
virtual TiXmlElement * to_XML (void) const
virtual void from_XML (TiXmlElement *)

Protected Attributes

Vector< std::string > inputs_name
Vector< std::string > inputs_units
Vector< std::string > inputs_description
Vector< std::string > outputs_name
Vector< std::string > outputs_units
Vector< std::string > outputs_description
bool display


Detailed Description

This class is used to store some information about the inputs and output variables of a neural network. That information basically consists on the names, units and descriptions of the inputs and the output variables.

Definition at line 38 of file inputs_outputs_information.h.


Constructor & Destructor Documentation

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

Default constructor. It creates a inputs-outputs information object with zero inputs and zero outputs.

Definition at line 41 of file inputs_outputs_information.cpp.

OpenNN::InputsOutputsInformation::InputsOutputsInformation ( const unsigned int &  new_inputs_number,
const unsigned int &  new_outputs_number 
) [explicit]

Inputs and outputs numbers constructor. It creates a inputs-outputs information object with given numbers of inputs and outputs. This constructor initializes the members of the object to their default values.

Parameters:
new_inputs_number Number of inputs.
new_outputs_number Number of outputs.

Definition at line 55 of file inputs_outputs_information.cpp.

OpenNN::InputsOutputsInformation::InputsOutputsInformation ( TiXmlElement *  inputs_outputs_information_element  )  [explicit]

explicit InputsOutputsInformation(const Vector< Vector<std::string> >&);

XML constructor. It creates an inputs-outputs information object and loads its members from a XML element.

Parameters:
inputs_outputs_information_element TinyXML element with the member data.

Definition at line 67 of file inputs_outputs_information.cpp.

OpenNN::InputsOutputsInformation::InputsOutputsInformation ( const InputsOutputsInformation other_inputs_outputs_information  ) 

Copy constructor. It creates a copy of an existing inputs outputs information object.

Parameters:
other_inputs_outputs_information Inputs outputs information object to be copied.

Definition at line 79 of file inputs_outputs_information.cpp.

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

Destructor.

Definition at line 89 of file inputs_outputs_information.cpp.


Member Function Documentation

InputsOutputsInformation & OpenNN::InputsOutputsInformation::operator= ( const InputsOutputsInformation other_inputs_outputs_information  ) 

Assignment operator. It assigns to this object the members of an existing inputs-outputs information object.

Parameters:
other_inputs_outputs_information Inputs-outputs information object to be assigned.

Definition at line 100 of file inputs_outputs_information.cpp.

bool OpenNN::InputsOutputsInformation::operator== ( const InputsOutputsInformation other_inputs_outputs_information  )  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_inputs_outputs_information Inputs-oputputs information object to be compared with.

Definition at line 135 of file inputs_outputs_information.cpp.

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

This method returns true if both the numbers of inputs and outputs are zero, and false otherwise.

Definition at line 158 of file inputs_outputs_information.cpp.

unsigned int OpenNN::InputsOutputsInformation::count_inputs_number ( void   )  const [inline]

This method returns the number of inputs in the multilayer perceptron.

Definition at line 81 of file inputs_outputs_information.h.

int OpenNN::InputsOutputsInformation::count_outputs_number ( void   )  const [inline]

This method returns the number of outputs neurons in the multilayer perceptron.

Definition at line 88 of file inputs_outputs_information.h.

const Vector< std::string > & OpenNN::InputsOutputsInformation::get_inputs_name ( void   )  const

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

Definition at line 179 of file inputs_outputs_information.cpp.

const std::string & OpenNN::InputsOutputsInformation::get_input_name ( const unsigned int &  input_index  )  const

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

Parameters:
input_index Index of input variable.

Definition at line 191 of file inputs_outputs_information.cpp.

const Vector< std::string > & OpenNN::InputsOutputsInformation::get_inputs_units ( void   )  const

This method returns the units of the input variables as strings. Such units are only used to give the user basic information about the problem at hand.

Definition at line 232 of file inputs_outputs_information.cpp.

const std::string & OpenNN::InputsOutputsInformation::get_input_units ( const unsigned int &  input_index  )  const

This method returns the units of a single input variable as a string. Such units are only used to give the user basic information about the problem at hand.

Parameters:
input_index Index of input variable.

Definition at line 244 of file inputs_outputs_information.cpp.

const Vector< std::string > & OpenNN::InputsOutputsInformation::get_inputs_description ( void   )  const

This method returns the description of the input variables as strings. Such descriptions are only used to give the user basic information about the problem at hand.

Definition at line 274 of file inputs_outputs_information.cpp.

const std::string & OpenNN::InputsOutputsInformation::get_input_description ( const unsigned int &  input_index  )  const

This method returns the description of a single input variable as a string. Such a description is only used to give the user basic information about the problem at hand.

Parameters:
input_index Index of input variable.

Definition at line 286 of file inputs_outputs_information.cpp.

const Vector< std::string > & OpenNN::InputsOutputsInformation::get_outputs_name ( void   )  const

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

Definition at line 316 of file inputs_outputs_information.cpp.

const std::string & OpenNN::InputsOutputsInformation::get_output_name ( const unsigned int &  output_index  )  const

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

Parameters:
output_index Index of output variable.

Definition at line 328 of file inputs_outputs_information.cpp.

const Vector< std::string > & OpenNN::InputsOutputsInformation::get_outputs_units ( void   )  const

This method returns the units of the output variables as strings. Such units are only used to give the user basic information about the problem at hand.

Definition at line 400 of file inputs_outputs_information.cpp.

const std::string & OpenNN::InputsOutputsInformation::get_output_units ( const unsigned int &  output_index  )  const

This method returns the units of a single output variable as a string. Such units are only used to give the user basic information about the problem at hand.

Parameters:
output_index Index of output variable.

Definition at line 412 of file inputs_outputs_information.cpp.

const Vector< std::string > & OpenNN::InputsOutputsInformation::get_outputs_description ( void   )  const

This method returns the descriptions of the output variables as strings. Such descriptions are only used to give the user basic information about the problem at hand.

Definition at line 358 of file inputs_outputs_information.cpp.

const std::string & OpenNN::InputsOutputsInformation::get_output_description ( const unsigned int &  output_index  )  const

This method returns the description of a single input variable as a string. Such a description is only used to give the user basic information about the problem at hand.

Parameters:
output_index Index of output variable.

Definition at line 370 of file inputs_outputs_information.cpp.

Vector< Vector< std::string > * > OpenNN::InputsOutputsInformation::get_information ( void   ) 

This method returns all the available information about the inputs and output variables. The format is a vector of pointers to vectors of size six:

  • Name of input variables.
  • Name of output variables.
  • Units of input variables.
  • Units of output variables.
  • Description of input variables.
  • Description of output variables.

Definition at line 450 of file inputs_outputs_information.cpp.

const bool & OpenNN::InputsOutputsInformation::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 472 of file inputs_outputs_information.cpp.

void OpenNN::InputsOutputsInformation::set ( void   ) 

This method sets zero inputs and outputs numbers. It also sets the rest of members to their default values.

Definition at line 483 of file inputs_outputs_information.cpp.

void OpenNN::InputsOutputsInformation::set ( const unsigned int &  new_inputs_number,
const unsigned int &  new_outputs_number 
)

This method sets new number of inputs and outputs. It also sets the rest of members to their default values.

Parameters:
new_inputs_number Number of inputs.
new_outputs_number Number of outputs.

Definition at line 500 of file inputs_outputs_information.cpp.

void OpenNN::InputsOutputsInformation::set ( const Vector< Vector< std::string > > &  new_variables_information  ) 

This method sets all the inputs and outputs information from a single vector.

Parameters:
new_variables_information Inputs and outputs information. The format is a vector of 6 subvectors:
  • Inputs name.
  • Inputs units.
  • Inputs description.
  • Outputs name.
  • Outputs units.
  • Outputs description.

Definition at line 547 of file inputs_outputs_information.cpp.

void OpenNN::InputsOutputsInformation::set ( const InputsOutputsInformation other_inputs_outputs_information  ) 

This method sets the members of this inputs-outputs information object with those from other inputs-outputs information object.

Parameters:
other_inputs_outputs_information Inputs-outputs information object to be copied.

Definition at line 515 of file inputs_outputs_information.cpp.

void OpenNN::InputsOutputsInformation::set_inputs_number ( const unsigned int &  new_inputs_number  ) 

This method sets a new number of inputs.

Parameters:
new_inputs_number Number of inputs.

Definition at line 583 of file inputs_outputs_information.cpp.

void OpenNN::InputsOutputsInformation::set_outputs_number ( const unsigned int &  new_outputs_number  ) 

This method sets a new number of outputs.

Parameters:
new_outputs_number Number of outputs.

Definition at line 596 of file inputs_outputs_information.cpp.

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

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

Definition at line 608 of file inputs_outputs_information.cpp.

void OpenNN::InputsOutputsInformation::set_inputs_name ( const Vector< std::string > &  new_inputs_name  ) 

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

Parameters:
new_inputs_name New names for the input variables.

Definition at line 635 of file inputs_outputs_information.cpp.

void OpenNN::InputsOutputsInformation::set_input_name ( const unsigned int &  input_index,
const std::string &  new_input_name 
)

This method sets the name of a single input variable. Such value is only used to give the user basic information on the problem at hand.

Parameters:
input_index Index of input variable.
new_input_name New name for the input variable with index i.

Definition at line 671 of file inputs_outputs_information.cpp.

void OpenNN::InputsOutputsInformation::set_inputs_units ( const Vector< std::string > &  new_inputs_units  ) 

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

Parameters:
new_inputs_units New units for the input variables.

Definition at line 709 of file inputs_outputs_information.cpp.

void OpenNN::InputsOutputsInformation::set_input_units ( const unsigned int &  input_index,
const std::string &  new_input_units 
)

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

Parameters:
input_index Index of input variable.
new_input_units New units for that input variable.

Definition at line 745 of file inputs_outputs_information.cpp.

void OpenNN::InputsOutputsInformation::set_inputs_description ( const Vector< std::string > &  new_inputs_description  ) 

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

Parameters:
new_inputs_description New description for the input variables.

Definition at line 783 of file inputs_outputs_information.cpp.

void OpenNN::InputsOutputsInformation::set_input_description ( const unsigned int &  input_index,
const std::string &  new_input_description 
)

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

Parameters:
input_index Index of input variable.
new_input_description New description for the input variable with index i.

Definition at line 820 of file inputs_outputs_information.cpp.

void OpenNN::InputsOutputsInformation::set_outputs_name ( const Vector< std::string > &  new_outputs_name  ) 

This method sets the names of the output variables. Such values are only used to give the user basic information on the problem at hand.

Parameters:
new_outputs_name New names for the output variables.

Definition at line 858 of file inputs_outputs_information.cpp.

void OpenNN::InputsOutputsInformation::set_output_name ( const unsigned int &  output_layer_index,
const std::string &  new_output_name 
)

This method sets the name of a single output variable. Such value is only used to give the user basic information on the problem at hand.

Parameters:
output_layer_index Index of output variable.
new_output_name New name for the output variable with index i.

Definition at line 894 of file inputs_outputs_information.cpp.

void OpenNN::InputsOutputsInformation::set_outputs_units ( const Vector< std::string > &  new_outputs_units  ) 

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

Parameters:
new_outputs_units New units for the output variables.

Definition at line 932 of file inputs_outputs_information.cpp.

void OpenNN::InputsOutputsInformation::set_output_units ( const unsigned int &  output_index,
const std::string &  new_output_units 
)

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

Parameters:
output_index Index of output variable.
new_output_units New units for that output variable.

Definition at line 968 of file inputs_outputs_information.cpp.

void OpenNN::InputsOutputsInformation::set_outputs_description ( const Vector< std::string > &  new_outputs_description  ) 

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

Parameters:
new_outputs_description New description for the output variables.

Definition at line 1006 of file inputs_outputs_information.cpp.

void OpenNN::InputsOutputsInformation::set_output_description ( const unsigned int &  output_index,
const std::string &  new_output_description 
)

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

Parameters:
output_index Index of output variable.
new_output_description New description for the output variable with index i.

Definition at line 1042 of file inputs_outputs_information.cpp.

void OpenNN::InputsOutputsInformation::set_information ( const Vector< Vector< std::string > > &  new_information  ) 

This method sets all the possible information about the inputs and output variables. The format is a vector of vectors of size six:

  • Name of input variables.
  • Name of output variables.
  • Units of input variables.
  • Units of output variables.
  • Description of input variables.
  • Description of output variables.
Parameters:
new_information Input and output variables information.

Definition at line 1088 of file inputs_outputs_information.cpp.

void OpenNN::InputsOutputsInformation::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 1128 of file inputs_outputs_information.cpp.

void OpenNN::InputsOutputsInformation::initialize_random ( void   ) 

Todo:

Definition at line 1138 of file inputs_outputs_information.cpp.

Vector< std::string > OpenNN::InputsOutputsInformation::write_default_inputs_name ( void   )  const

This method returns the default names for the input variables:

  • input_1
  • ...
  • input_n

Definition at line 1153 of file inputs_outputs_information.cpp.

Vector< std::string > OpenNN::InputsOutputsInformation::write_default_outputs_name ( void   )  const

This method returns the default names for the output variables:

  • output_1
  • ...
  • output_n

Definition at line 1190 of file inputs_outputs_information.cpp.

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

This method returns a string representation of the current inputs-outputs information object.

Definition at line 1222 of file inputs_outputs_information.cpp.

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

This method serializes the inputs-outputs information 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 1244 of file inputs_outputs_information.cpp.

void OpenNN::InputsOutputsInformation::from_XML ( TiXmlElement *  inputs_outputs_information_element  )  [virtual]

This method deserializes a TinyXML element into this inputs-outputs information object.

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

Definition at line 1392 of file inputs_outputs_information.cpp.


Member Data Documentation

Name of input variables.

Definition at line 182 of file inputs_outputs_information.h.

Units of input variables.

Definition at line 186 of file inputs_outputs_information.h.

Description of input variables.

Definition at line 190 of file inputs_outputs_information.h.

Name of output variables.

Definition at line 194 of file inputs_outputs_information.h.

Units of output variables.

Definition at line 198 of file inputs_outputs_information.h.

Description of output variables.

Definition at line 202 of file inputs_outputs_information.h.

Display messages to screen.

Definition at line 206 of file inputs_outputs_information.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