VW::config::options_i Struct Reference

#include <options.h>

Inheritance diagram for VW::config::options_i:

Classes
struct	is_vector
struct	is_vector< std::vector< T, A > >

Public Member Functions
virtual void	add_and_parse (const option_group_definition &group)=0
virtual void	tint (const std::string &reduction_name)=0
virtual void	reset_tint ()=0
virtual bool	add_parse_and_check_necessary (const option_group_definition &group)=0
virtual bool	was_supplied (const std::string &key) const =0
virtual std::string	help (const std::vector< std::string > &enabled_reductions) const =0
virtual std::vector< std::shared_ptr< base_option > >	get_all_options ()=0
virtual std::vector< std::shared_ptr< const base_option > >	get_all_options () const =0
virtual std::shared_ptr< base_option >	get_option (const std::string &key)=0
virtual std::shared_ptr< const base_option >	get_option (const std::string &key) const =0
virtual std::map< std::string, std::vector< option_group_definition > >	get_collection_of_options () 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
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
template<typename T >
bool	insert_arguments (const std::string &name, T expected_val)
virtual void	check_unregistered (VW::io::logger &logger)=0
virtual	~options_i ()=default

Constructor & Destructor Documentation

~options_i()

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

virtualdefault

Member Function Documentation

add_and_parse()

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

pure virtual

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

add_parse_and_check_necessary()

virtual bool VW::config::options_i::add_parse_and_check_necessary ( const option_group_definition &  group )

pure virtual

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

check_unregistered()

virtual void VW::config::options_i::check_unregistered ( VW::io::logger &  logger )

pure virtual

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

get_all_options() [1/2]

virtual std::vector<std::shared_ptr<base_option> > VW::config::options_i::get_all_options ( )

pure virtual

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

get_all_options() [2/2]

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

pure virtual

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

get_collection_of_options()

virtual std::map<std::string, std::vector<option_group_definition> > VW::config::options_i::get_collection_of_options ( ) const

pure virtual

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

get_option() [1/2]

virtual std::shared_ptr<base_option> VW::config::options_i::get_option ( const std::string &  key )

pure virtual

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

get_option() [2/2]

virtual std::shared_ptr<const base_option> VW::config::options_i::get_option ( const std::string &  key ) const

pure virtual

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

get_positional_tokens()

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

inlinevirtual

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

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

help()

virtual std::string VW::config::options_i::help ( const std::vector< std::string > &  enabled_reductions ) const

pure virtual

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

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_boost_po.

insert_arguments()

template<typename T >

bool VW::config::options_i::insert_arguments ( const std::string &  name, T  expected_val  )

inline

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_boost_po.

reset_tint()

virtual void VW::config::options_i::reset_tint ( )

pure virtual

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

tint()

virtual void VW::config::options_i::tint ( const std::string &  reduction_name )

pure virtual

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

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_boost_po.

---

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

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