#include <instances_information.h>
Public Member Functions | |
InstancesInformation (void) | |
InstancesInformation (const unsigned int &) | |
InstancesInformation (TiXmlElement *) | |
InstancesInformation (const InstancesInformation &) | |
virtual | ~InstancesInformation (void) |
InstancesInformation & | operator= (const InstancesInformation &) |
bool | operator== (const InstancesInformation &) const |
const unsigned int & | get_instances_number (void) const |
unsigned int | count_training_instances_number (void) const |
unsigned int | count_generalization_instances_number (void) const |
unsigned int | count_testing_instances_number (void) const |
const Vector< unsigned int > & | get_training_indices (void) const |
const Vector< unsigned int > & | get_generalization_indices (void) const |
const Vector< unsigned int > & | get_testing_indices (void) const |
const bool & | get_display (void) const |
void | set (void) |
void | set (const unsigned int &) |
void | set (TiXmlElement *) |
void | set_instances_number (const unsigned int &) |
void | set_training_indices (const Vector< unsigned int > &) |
void | set_generalization_indices (const Vector< unsigned int > &) |
void | set_testing_indices (const Vector< unsigned int > &) |
void | set_training (void) |
void | set_generalization (void) |
void | set_testing (void) |
void | set_default_instances_indices (void) |
void | set_display (const bool &) |
void | split_given_indices (const Vector< unsigned int > &, const Vector< unsigned int > &, const Vector< unsigned int > &) |
void | split_random_indices (const double &, const double &, const double &) |
void | split_random_indices (void) |
void | split_sequential_indices (const double &, const double &, const double &) |
void | split_sequential_indices (void) |
std::string | to_string (void) const |
TiXmlElement * | to_XML (void) const |
void | from_XML (TiXmlElement *) |
Definition at line 39 of file instances_information.h.
OpenNN::InstancesInformation::InstancesInformation | ( | void | ) | [explicit] |
Default constructor. It creates a instances information object with zero instances. It also initializes the rest of class members to their default values.
Definition at line 47 of file instances_information.cpp.
OpenNN::InstancesInformation::InstancesInformation | ( | const unsigned int & | new_instances_number | ) | [explicit] |
Instances number constructor. It creates a data set object with a given number of instances. It also initializes the rest of class members to their default values.
new_instances_number | Number of instances in the data set. |
Definition at line 60 of file instances_information.cpp.
OpenNN::InstancesInformation::InstancesInformation | ( | TiXmlElement * | instances_information_element | ) | [explicit] |
XML constructor. It creates a instances information object by loading the object members from a Tiny XML element.
instances_information_element | XML element from the Tiny XML library. |
Definition at line 72 of file instances_information.cpp.
OpenNN::InstancesInformation::InstancesInformation | ( | const InstancesInformation & | other_instances_information | ) |
Copy constructor. It creates a copy of an existing instances information object.
other_instances_information | Instances information object to be copied. |
Definition at line 84 of file instances_information.cpp.
OpenNN::InstancesInformation::~InstancesInformation | ( | void | ) | [virtual] |
InstancesInformation & OpenNN::InstancesInformation::operator= | ( | const InstancesInformation & | other_instances_information | ) |
Assignment operator. It assigns to the current object the members of an existing instances information object.
other_instances_information | Instances information object to be assigned. |
Definition at line 111 of file instances_information.cpp.
bool OpenNN::InstancesInformation::operator== | ( | const InstancesInformation & | other_instances_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_instances_information Instances information object to be compared with.
Definition at line 141 of file instances_information.cpp.
const unsigned int& OpenNN::InstancesInformation::get_instances_number | ( | void | ) | const [inline] |
This method returns the number of instances in the data set.
Definition at line 78 of file instances_information.h.
unsigned int OpenNN::InstancesInformation::count_training_instances_number | ( | void | ) | const [inline] |
This method returns the number of instances in the data set which will be used for training.
Definition at line 85 of file instances_information.h.
unsigned int OpenNN::InstancesInformation::count_generalization_instances_number | ( | void | ) | const [inline] |
This method returns the number of instances in the data set which will be used for generalization.
Definition at line 92 of file instances_information.h.
unsigned int OpenNN::InstancesInformation::count_testing_instances_number | ( | void | ) | const [inline] |
This method returns the number of instances in the data set which will be used for testing.
Definition at line 99 of file instances_information.h.
const Vector< unsigned int > & OpenNN::InstancesInformation::get_training_indices | ( | void | ) | const |
This method returns the indices of the instances which will be used for training.
Definition at line 163 of file instances_information.cpp.
const Vector< unsigned int > & OpenNN::InstancesInformation::get_generalization_indices | ( | void | ) | const |
This method returns the indices of the instances which will be used for generalization.
Definition at line 173 of file instances_information.cpp.
const Vector< unsigned int > & OpenNN::InstancesInformation::get_testing_indices | ( | void | ) | const |
This method returns the indices of the instances which will be used for testing.
Definition at line 183 of file instances_information.cpp.
const bool & OpenNN::InstancesInformation::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 194 of file instances_information.cpp.
void OpenNN::InstancesInformation::set | ( | void | ) |
This method sets a instances information object with zero instances.
Definition at line 204 of file instances_information.cpp.
void OpenNN::InstancesInformation::set | ( | const unsigned int & | new_instances_number | ) |
This method sets a new number of instances in the instances information object. All the instances are set for training.
new_instances_number | Number of instances. |
Definition at line 218 of file instances_information.cpp.
void OpenNN::InstancesInformation::set | ( | TiXmlElement * | instances_information_element | ) |
This method sets the instances information members from a XML element.
instances_information_element | Pointer to a Tiny XML element containing the member data. |
Definition at line 231 of file instances_information.cpp.
void OpenNN::InstancesInformation::set_instances_number | ( | const unsigned int & | new_instances_number | ) |
This method sets a new number of instances in the data set. All instances are also set for training.
new_instances_number | Number of instances. |
Definition at line 399 of file instances_information.cpp.
void OpenNN::InstancesInformation::set_training_indices | ( | const Vector< unsigned int > & | new_training_indices | ) |
This method sets new indices for the training instances from a vector of integers. The size of that vector is the number of training instances. This method does not check for repeated indices.
new_training_indices | Indices of training instances. |
Definition at line 245 of file instances_information.cpp.
void OpenNN::InstancesInformation::set_generalization_indices | ( | const Vector< unsigned int > & | new_generalization_indices | ) |
This method sets new indices for the generalization instances from a vector of integers. The size of that vector is the number of generalization instances. This method does not check for repeated indices.
new_generalization_indices | Indices of generalization instances. |
Definition at line 277 of file instances_information.cpp.
void OpenNN::InstancesInformation::set_testing_indices | ( | const Vector< unsigned int > & | new_testing_indices | ) |
This method sets new indices for the testing instances from a vector of integers. The size of that vector is the number of testing instances. This method does not check for repeated indices.
new_testing_indices | Indices of testing instances. |
Definition at line 309 of file instances_information.cpp.
void OpenNN::InstancesInformation::set_training | ( | void | ) |
This method sets all the instances in the data set for training.
Definition at line 338 of file instances_information.cpp.
void OpenNN::InstancesInformation::set_generalization | ( | void | ) |
This method sets all the instances in the data set for generalization.
Definition at line 350 of file instances_information.cpp.
void OpenNN::InstancesInformation::set_testing | ( | void | ) |
This method sets all the instances in the data set for testing.
Definition at line 362 of file instances_information.cpp.
void OpenNN::InstancesInformation::set_default_instances_indices | ( | void | ) |
This method splits the instances indices with the sequential method.
Definition at line 374 of file instances_information.cpp.
void OpenNN::InstancesInformation::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.
new_display | Display value. |
Definition at line 387 of file instances_information.cpp.
void OpenNN::InstancesInformation::split_given_indices | ( | const Vector< unsigned int > & | new_training_indices, | |
const Vector< unsigned int > & | new_generalization_indices, | |||
const Vector< unsigned int > & | new_testing_indices | |||
) |
This method sets new training, generalization and testing indices from given vectors.
new_training_indices | Indices of instances to be used for training. | |
new_generalization_indices | Indices of instances to be used for generalization. | |
new_testing_indices | Indices of instances to be used for testing. |
Definition at line 595 of file instances_information.cpp.
void OpenNN::InstancesInformation::split_random_indices | ( | const double & | training_instances_ratio, | |
const double & | generalization_instances_ratio, | |||
const double & | testing_instances_ratio | |||
) |
This method creates new training, generalization and testing indices at random.
training_instances_ratio | Ratio of training instances in the data set. | |
generalization_instances_ratio | Ratio of generalization instances in the data set. | |
testing_instances_ratio | Ratio of testing instances in the data set. |
Definition at line 624 of file instances_information.cpp.
void OpenNN::InstancesInformation::split_random_indices | ( | void | ) |
This method creates new training, generalization and testing indices at random. It uses the following default values:
Definition at line 693 of file instances_information.cpp.
void OpenNN::InstancesInformation::split_sequential_indices | ( | const double & | training_instances_ratio, | |
const double & | generalization_instances_ratio, | |||
const double & | testing_instances_ratio | |||
) |
This method creates new training, generalization and testing indices with sequential indices.
training_instances_ratio | Ratio of training instances in the data set. | |
generalization_instances_ratio | Ratio of generalization instances in the data set. | |
testing_instances_ratio | Ratio of testing instances in the data set. |
Definition at line 706 of file instances_information.cpp.
void OpenNN::InstancesInformation::split_sequential_indices | ( | void | ) |
This method creates new training, generalization and testing indices with sequential indices. It uses the following default values:
Definition at line 752 of file instances_information.cpp.
std::string OpenNN::InstancesInformation::to_string | ( | void | ) | const |
This method returns a string representation of the current instances information object.
Definition at line 762 of file instances_information.cpp.
TiXmlElement * OpenNN::InstancesInformation::to_XML | ( | void | ) | const |
This method serializes the instances 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 417 of file instances_information.cpp.
void OpenNN::InstancesInformation::from_XML | ( | TiXmlElement * | instances_information_element | ) |
This method deserializes a TinyXML element into this instances information object.
instances_information_element | Pointer to a XML element containing the member data. |
Definition at line 494 of file instances_information.cpp.