Ultra 0.9.4
Loading...
Searching...
No Matches
ultra::src::basic_class_oracle Class Reference

#include <oracle.h>

Inheritance diagram for ultra::src::basic_class_oracle:
ultra::src::basic_oracle ultra::src::basic_binary_oracle< P, true > ultra::src::basic_binary_oracle< gp::team< I >, S > ultra::src::basic_gaussian_oracle< P, true > ultra::src::basic_gaussian_oracle< gp::team< I >, S > ultra::src::team_class_oracle< basic_binary_oracle< I, S > > ultra::src::team_class_oracle< basic_gaussian_oracle< I, S > > ultra::src::basic_binary_oracle< I, S > ultra::src::basic_gaussian_oracle< I, S > ultra::src::class_oracle_adaptor< O > ultra::src::team_class_oracle< O, C >

Public Member Functions

value_t operator() (const std::vector< value_t > &) const final
 Returns the predicted class label.
std::string name (const value_t &) const final
 Returns the class name, falling back to a numeric name for unknown IDs.
Public Member Functions inherited from ultra::src::basic_oracle
virtual bool is_valid () const =0
virtual classification_result tag (const std::vector< value_t > &) const =0

Protected Member Functions

 basic_class_oracle (std::vector< std::string >={})
bool load_names (std::istream &)
 Loads the class names, accepting a zero count for omitted names.
bool save_names (std::ostream &) const
 Saves a count followed by one class name per line.

Static Protected Member Functions

static std::vector< std::string > class_names (const dataframe &)
 Collects the class names from the training set.

Detailed Description

The basic interface of a classification oracle.

This class:

  • extends the interface of class basic_oracle to handle typical requirements of classification tasks;
  • factorizes out some code from specific classification schemes;
  • optionally stores class names.

Constructor & Destructor Documentation

◆ basic_class_oracle()

ultra::src::basic_class_oracle::basic_class_oracle ( std::vector< std::string > names = {})
explicitprotected

Constructs a classifier with optional class names.

Parameters
[in]namesclass names, or an empty vector for numeric names

Member Function Documentation

◆ name()

std::string ultra::src::basic_class_oracle::name ( const value_t & a) const
nodiscardfinalvirtual

Returns the class name, falling back to a numeric name for unknown IDs.

Implements ultra::src::basic_oracle.

◆ operator()()

value_t ultra::src::basic_class_oracle::operator() ( const std::vector< value_t > & e) const
nodiscardfinalvirtual

Returns the predicted class label.

Implements ultra::src::basic_oracle.


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