OpenNN  2.2
Open Neural Networks Library
Classes | Public Member Functions | Private Attributes | List of all members
OpenNN::YoudenIndexOptimizationThreshold Class Reference

#include <youden_index_optimization_threshold.h>

Inheritance diagram for OpenNN::YoudenIndexOptimizationThreshold:
OpenNN::ThresholdSelectionAlgorithm

Classes

struct  YoudenIndexOptimizationThresholdResults
 

Public Member Functions

 YoudenIndexOptimizationThreshold (void)
 
 YoudenIndexOptimizationThreshold (TrainingStrategy *)
 
 YoudenIndexOptimizationThreshold (const tinyxml2::XMLDocument &)
 
 YoudenIndexOptimizationThreshold (const std::string &)
 
virtual ~YoudenIndexOptimizationThreshold (void)
 
const double & get_minimum_threshold (void) const
 
const double & get_maximum_threshold (void) const
 
const double & get_step (void) const
 
void set_default (void)
 
void set_minimum_threshold (const double &)
 
void set_maximum_threshold (const double &)
 
void set_step (const double &)
 
YoudenIndexOptimizationThresholdResultsperform_threshold_selection (void)
 
Matrix< std::string > to_string_matrix (void) const
 
tinyxml2::XMLDocument * to_XML (void) const
 
void from_XML (const tinyxml2::XMLDocument &)
 
void write_XML (tinyxml2::XMLPrinter &) const
 
void save (const std::string &) const
 
void load (const std::string &)
 
- Public Member Functions inherited from OpenNN::ThresholdSelectionAlgorithm
 ThresholdSelectionAlgorithm (void)
 
 ThresholdSelectionAlgorithm (TrainingStrategy *)
 
 ThresholdSelectionAlgorithm (const std::string &)
 
 ThresholdSelectionAlgorithm (const tinyxml2::XMLDocument &)
 
virtual ~ThresholdSelectionAlgorithm (void)
 
TrainingStrategyget_training_strategy_pointer (void) const
 
bool has_training_strategy (void) const
 
const bool & get_reserve_binary_classification_tests_data (void) const
 
const bool & get_reserve_function_data (void) const
 
const bool & get_display (void) const
 
void set_training_strategy_pointer (TrainingStrategy *)
 
void set_default (void)
 
void set_reserve_binary_classification_tests_data (const bool &)
 
void set_reserve_function_data (const bool &)
 
void set_display (const bool &)
 
Matrix< size_t > calculate_confusion (const double &) const
 
Vector< double > calculate_binary_classification_test (const Matrix< size_t > &) const
 
void check (void) const
 

Private Attributes

double minimum_threshold
 
double maximum_threshold
 
double step
 

Additional Inherited Members

- Public Types inherited from OpenNN::ThresholdSelectionAlgorithm
enum  StoppingCondition { PerfectConfusionMatrix, AlgorithmFinished }
 
- Protected Attributes inherited from OpenNN::ThresholdSelectionAlgorithm
TrainingStrategytraining_strategy_pointer
 
bool reserve_binary_classification_tests_data
 
bool reserve_function_data
 
bool display
 

Detailed Description

This concrete class represents a Youden's index optimization for the threshold selection of a neural network.

Definition at line 47 of file youden_index_optimization_threshold.h.

Constructor & Destructor Documentation

◆ YoudenIndexOptimizationThreshold() [1/3]

OpenNN::YoudenIndexOptimizationThreshold::YoudenIndexOptimizationThreshold ( TrainingStrategy new_training_strategy_pointer)
explicit

Training strategy constructor.

Parameters
new_training_strategy_pointerPointer to a training strategy object.

Definition at line 37 of file youden_index_optimization_threshold.cpp.

◆ YoudenIndexOptimizationThreshold() [2/3]

OpenNN::YoudenIndexOptimizationThreshold::YoudenIndexOptimizationThreshold ( const tinyxml2::XMLDocument &  youden_index_optimization_document)
explicit

XML constructor.

Parameters
youden_index_optimization_documentPointer to a TinyXML document containing the youden index optimization data.

Definition at line 48 of file youden_index_optimization_threshold.cpp.

◆ YoudenIndexOptimizationThreshold() [3/3]

OpenNN::YoudenIndexOptimizationThreshold::YoudenIndexOptimizationThreshold ( const std::string &  file_name)
explicit

File constructor.

Parameters
file_nameName of XML youden index optimization file.

Definition at line 59 of file youden_index_optimization_threshold.cpp.

Member Function Documentation

◆ from_XML()

void OpenNN::YoudenIndexOptimizationThreshold::from_XML ( const tinyxml2::XMLDocument &  document)

Deserializes a TinyXML document into this youden index optimization object.

Parameters
documentTinyXML document containing the member data.

Definition at line 531 of file youden_index_optimization_threshold.cpp.

◆ load()

void OpenNN::YoudenIndexOptimizationThreshold::load ( const std::string &  file_name)

Loads a youden index optimization object from a XML-type file.

Parameters
file_nameName of youden index optimization XML-type file.

Definition at line 662 of file youden_index_optimization_threshold.cpp.

◆ save()

void OpenNN::YoudenIndexOptimizationThreshold::save ( const std::string &  file_name) const

Saves to a XML-type file the members of the youden index optimization object.

Parameters
file_nameName of youden index optimization XML-type file.

Definition at line 647 of file youden_index_optimization_threshold.cpp.

◆ set_maximum_threshold()

void OpenNN::YoudenIndexOptimizationThreshold::set_maximum_threshold ( const double &  new_maximum_threshold)

Sets the maximum value of the threshold selection algotihm.

Parameters
new_maximum_thresholdMaximum threshold for the algorithm.

Definition at line 147 of file youden_index_optimization_threshold.cpp.

◆ set_minimum_threshold()

void OpenNN::YoudenIndexOptimizationThreshold::set_minimum_threshold ( const double &  new_minimum_threshold)

Sets the minimum value of the threshold selection algotihm.

Parameters
new_minimum_thresholdMinimum threshold for the algorithm.

Definition at line 122 of file youden_index_optimization_threshold.cpp.

◆ set_step()

void OpenNN::YoudenIndexOptimizationThreshold::set_step ( const double &  new_step)

Sets the step between two iterations of the threshold selection algotihm.

Parameters
new_stepDifference of threshold between two consecutive iterations.

Definition at line 172 of file youden_index_optimization_threshold.cpp.

◆ to_XML()

tinyxml2::XMLDocument * OpenNN::YoudenIndexOptimizationThreshold::to_XML ( void  ) const

Prints to the screen the youden index optimization parameters, the stopping criteria and other user stuff concerning the youden index optimization object.

Definition at line 367 of file youden_index_optimization_threshold.cpp.

◆ write_XML()

void OpenNN::YoudenIndexOptimizationThreshold::write_XML ( tinyxml2::XMLPrinter &  file_stream) const

Serializes the Youden's index optimization threshold object into a XML document of the TinyXML library without keep the DOM tree in memory. See the OpenNN manual for more information about the format of this document.

Definition at line 472 of file youden_index_optimization_threshold.cpp.


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