VW::config::options_i Class 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 ()
std::vector< std::shared_ptr< base_option > >	get_all_options ()
std::vector< std::shared_ptr< const base_option > >	get_all_options () const
std::shared_ptr< base_option >	get_option (const std::string &key)
std::shared_ptr< const base_option >	get_option (const std::string &key) const
std::map< std::string, std::vector< option_group_definition > >	get_collection_of_options () const
const std::vector< option_group_definition > &	get_all_option_group_definitions () const
template<typename T >
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 bool	was_supplied (const std::string &key) const =0
virtual void	insert (const std::string &key, const std::string &value)=0
virtual void	replace (const std::string &key, const std::string &value)=0
virtual std::vector< std::string >	get_positional_tokens () const
virtual std::vector< std::string >	check_unregistered ()=0
	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...
virtual	~options_i ()=default

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

Constructor & Destructor Documentation

~options_i()

virtual VW::config::options_i::~options_i ( )

virtualdefault

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

)

check_unregistered()

virtual std::vector< std::string > VW::config::options_i::check_unregistered ( )

pure virtual

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

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

get_all_option_group_definitions()

const std::vector< option_group_definition > & VW::config::options_i::get_all_option_group_definitions

(

)

const

get_all_options() [1/2]

std::vector< std::shared_ptr< base_option > > VW::config::options_i::get_all_options

(

)

get_all_options() [2/2]

std::vector< std::shared_ptr< const base_option > > VW::config::options_i::get_all_options

(

)

const

get_collection_of_options()

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

(

)

const

get_option() [1/2]

std::shared_ptr< base_option > VW::config::options_i::get_option

(

const std::string &

key

)

get_option() [2/2]

std::shared_ptr< const base_option > VW::config::options_i::get_option

(

const std::string &

key

)

const

get_positional_tokens()

virtual std::vector< std::string > VW::config::options_i::get_positional_tokens ( ) const

inlinevirtual

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

get_typed_option() [1/2]

template<typename T >

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

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

insert()

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

pure virtual

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

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_name_extractor, and VW::config::options_cli.

reset_tint()

void VW::config::options_i::reset_tint

(

)

tint()

void VW::config::options_i::tint

(

const std::string &

reduction_name

)

was_supplied()

virtual bool VW::config::options_i::was_supplied ( const std::string &  key ) const

pure virtual

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

Member Data Documentation

DEFAULT_TINT

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

staticconstexpr

---

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

• /nix/store/lp9wjr07fg70x7djxjnivn11qk52df1s-source/vowpalwabbit/config/include/vw/config/options.h