VW::config::options_i Struct Reference

#include <options.h>

Inheritance diagram for VW::config::options_i:

Public Member Functions
void	add_and_parse (const option_group_definition &group)
bool	add_parse_and_check_necessary (const option_group_definition &group)
void	tint (const std::string &reduction_name)
void	reset_tint ()
template<typename T >
VW_ATTR(nodiscard) std VW_ATTR(nodiscard) std VW_ATTR(nodiscard) std VW_ATTR(nodiscard) std VW_ATTR(nodiscard) std VW_ATTR(nodiscard) const std typed_option< T > &	get_typed_option (const std::string &key)
template<typename T >
const typed_option< T > &	get_typed_option (const std::string &key) const
virtual void	internal_add_and_parse (const option_group_definition &group)=0
virtual void	replace (const std::string &key, const std::string &value)=0
virtual VW_ATTR(nodiscard) virtual std	~options_i ()=default
	Check for unregistered options and validate input. Throws if there is an error. Returns a vector of warning strings if there are warnings produced. More...

Static Public Attributes
static constexpr const char *	m_default_tint = "general"

Protected Attributes
std::map< std::string, std::vector< option_group_definition > >	m_option_group_dic
std::vector< option_group_definition >	m_option_group_definitions
std::string	m_current_reduction_tint = m_default_tint
std::map< std::string, std::shared_ptr< base_option > >	m_options
std::map< char, std::shared_ptr< base_option > >	m_short_options

Constructor & Destructor Documentation

~options_i()

virtual VW_ATTR (nodiscard) virtual std VW::config::options_i::~options_i ( )

virtualdefault

Check for unregistered options and validate input. Throws if there is an error. Returns a vector of warning strings if there are warnings produced.

Member Function Documentation

add_and_parse()

void VW::config::options_i::add_and_parse

(

const option_group_definition &

group

)

add_parse_and_check_necessary()

bool VW::config::options_i::add_parse_and_check_necessary

(

const option_group_definition &

group

)

get_typed_option() [1/2]

template<typename T >

VW_ATTR (nodiscard) std VW_ATTR (nodiscard) std VW_ATTR (nodiscard) std VW_ATTR (nodiscard) std VW_ATTR (nodiscard) std VW_ATTR (nodiscard) const std typed_option<T>& VW::config::options_i::get_typed_option ( const std::string &  key ) const

inline

get_typed_option() [2/2]

template<typename T >

const typed_option<T>& VW::config::options_i::get_typed_option ( const std::string &  key ) const

inline

internal_add_and_parse()

virtual void VW::config::options_i::internal_add_and_parse ( const option_group_definition &  group )

pure virtual

Implemented in VW::config::options_cli, and VW::config::options_name_extractor.

replace()

virtual void VW::config::options_i::replace ( const std::string &  key, const std::string &  value  )

pure virtual

Implemented in VW::config::options_cli, and VW::config::options_name_extractor.

reset_tint()

void VW::config::options_i::reset_tint

(

)

tint()

void VW::config::options_i::tint

(

const std::string &

reduction_name

)

Member Data Documentation

m_current_reduction_tint

std::string VW::config::options_i::m_current_reduction_tint = m_default_tint

protected

m_default_tint

constexpr const char* VW::config::options_i::m_default_tint = "general"

static

m_option_group_definitions

std::vector<option_group_definition> VW::config::options_i::m_option_group_definitions

protected

m_option_group_dic

std::map<std::string, std::vector<option_group_definition> > VW::config::options_i::m_option_group_dic

protected

m_options

std::map<std::string, std::shared_ptr<base_option> > VW::config::options_i::m_options

protected

m_short_options

std::map<char, std::shared_ptr<base_option> > VW::config::options_i::m_short_options

protected

---

The documentation for this struct was generated from the following file:

• /__w/vowpal_wabbit/vowpal_wabbit/vowpalwabbit/config/options.h