Vowpal Wabbit
Public Member Functions | Static Public Member Functions | List of all members
VW::config::option_builder< T > Struct Template Reference

#include <options.h>

Public Member Functions

template<typename... Args>
 option_builder (Args &&... args)
 
option_builderdefault_value (const typename T::value_type &value)
 
option_buildershort_name (const std::string &short_name)
 
template<typename U >
std::string help_one_of (const std::string &, const std::set< U > &)
 
std::string help_one_of (const std::string &help, const std::set< std::string > &s)
 
std::string help_one_of (const std::string &help, const std::set< int > &s)
 
option_builderhelp (const std::string &help)
 
option_builderkeep (bool keep=true)
 
option_buildernecessary (bool necessary=true)
 
option_builderone_of (std::set< typename T::value_type > args)
 
option_builderallow_override (bool allow_override=true)
 

Static Public Member Functions

static std::shared_ptr< base_optionfinalize (option_builder &&option)
 

Constructor & Destructor Documentation

◆ option_builder()

template<typename T>
template<typename... Args>
VW::config::option_builder< T >::option_builder ( Args &&...  args)
inline

Member Function Documentation

◆ allow_override()

template<typename T>
option_builder& VW::config::option_builder< T >::allow_override ( bool  allow_override = true)
inline

◆ default_value()

template<typename T>
option_builder& VW::config::option_builder< T >::default_value ( const typename T::value_type &  value)
inline

◆ finalize()

template<typename T>
static std::shared_ptr<base_option> VW::config::option_builder< T >::finalize ( option_builder< T > &&  option)
inlinestatic

◆ help()

template<typename T>
option_builder& VW::config::option_builder< T >::help ( const std::string &  help)
inline

◆ help_one_of() [1/3]

template<typename T>
template<typename U >
std::string VW::config::option_builder< T >::help_one_of ( const std::string &  ,
const std::set< U > &   
)
inline

◆ help_one_of() [2/3]

template<typename T>
std::string VW::config::option_builder< T >::help_one_of ( const std::string &  help,
const std::set< std::string > &  s 
)
inline

◆ help_one_of() [3/3]

template<typename T>
std::string VW::config::option_builder< T >::help_one_of ( const std::string &  help,
const std::set< int > &  s 
)
inline

◆ keep()

template<typename T>
option_builder& VW::config::option_builder< T >::keep ( bool  keep = true)
inline

◆ necessary()

template<typename T>
option_builder& VW::config::option_builder< T >::necessary ( bool  necessary = true)
inline

◆ one_of()

template<typename T>
option_builder& VW::config::option_builder< T >::one_of ( std::set< typename T::value_type >  args)
inline

◆ short_name()

template<typename T>
option_builder& VW::config::option_builder< T >::short_name ( const std::string &  short_name)
inline

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