ultra::src::basic_binary_oracle< I, S > Class Template Reference

#include <oracle.h>

Inheritance diagram for ultra::src::basic_binary_oracle< I, S >:

Public Member Functions
	basic_binary_oracle (const I &, const dataframe &, std::vector< std::string >={})
	basic_binary_oracle (std::istream &, const symbol_set &)
classification_result	tag (const std::vector< value_t > &) const final
bool	is_valid () const final
bool	save (std::ostream &) const final
Public Member Functions inherited from ultra::src::basic_class_oracle
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.

Static Public Attributes
static const std::string	SERIALIZE_ID

Additional Inherited Members
Protected Member Functions inherited from ultra::src::basic_class_oracle
	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 inherited from ultra::src::basic_class_oracle
static std::vector< std::string >	class_names (const dataframe &)
	Collects the class names from the training set.

Detailed Description

template<class I, bool S>
class ultra::src::basic_binary_oracle< I, S >

Oracle for Binary Classification.

Template Parameters

I	individual
S	stores the individual inside vs keep a reference only

This class transforms individuals into oracles that can be used for binary classification tasks.

Constructor & Destructor Documentation

basic_binary_oracle() [1/2]

template<class I, bool S>

basic_binary_oracle::basic_binary_oracle	(	const I &	ind,
		const dataframe &	d,
		std::vector< std::string >	names = {} )

Parameters

[in]	ind	individual "to be transformed" into an oracle
[in]	d	the training set
[in]	names	optional class names

basic_binary_oracle() [2/2]

template<class I, bool S>

basic_binary_oracle::basic_binary_oracle	(	std::istream &	in,
		const symbol_set &	ss )

Constructs the object reading data from an input stream.

Parameters

[in]	in	input stream
[in]	ss	active symbol set

Member Function Documentation

is_valid()

template<class I, bool S>

bool basic_binary_oracle::is_valid ( ) const

nodiscardfinalvirtual

Returns

true if the object passes the internal consistency check

Implements ultra::src::basic_oracle.

save()

template<class I, bool S>

bool basic_binary_oracle::save ( std::ostream & out ) const

finalvirtual

Saves the oracle on persistent storage.

Parameters

[out]

out

output stream

Returns

true on success

Implements ultra::src::basic_oracle.

tag()

template<class I, bool S>

classification_result basic_binary_oracle::tag ( const std::vector< value_t > & ex ) const

nodiscardfinalvirtual

Parameters

[in]

ex

input example for the lambda function

Returns

the class of e (numerical id) and the confidence level (in the [0,1] interval)

Implements ultra::src::basic_oracle.

---

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

• oracle.h
• oracle.tcc