VW::config::option_builder< T > Class Template Reference

#include <option_builder.h>

Public Member Functions
template<typename... Args>
	option_builder (Args &&... args)
option_builder &	default_value (const typename T::value_type &value)
option_builder &	short_name (const std::string &short_name)
option_builder &	short_name (char short_name)
option_builder &	help (const std::string &help)
option_builder &	hidden (bool hidden=true)
	Hides the option from help output. More...
option_builder &	experimental (bool experimental=true)
	Marks this as an experimental option. More...
option_builder &	keep (bool keep=true)
option_builder &	necessary (bool necessary=true)
option_builder &	one_of (std::set< typename T::value_type > args)
template<typename U = T>
std::enable_if<!details::is_vector< typenameU::value_type >::value, option_builder & >::type	allow_override (bool allow_override=true)
option_builder &	tags (std::initializer_list< std::string > input_tags)

Static Public Member Functions
static std::shared_ptr< base_option >	finalize (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 >

template<typename U = T>

std::enable_if<!details::is_vector< typenameU::value_type >::value, option_builder & >::type 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

experimental()

template<typename T >

option_builder & VW::config::option_builder< T >::experimental ( bool  experimental = true )

inline

Marks this as an experimental option.

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

hidden()

template<typename T >

option_builder & VW::config::option_builder< T >::hidden ( bool  hidden = true )

inline

Hides the option from help output.

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() [1/2]

template<typename T >

option_builder & VW::config::option_builder< T >::short_name ( char  short_name )

inline

short_name() [2/2]

template<typename T >

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

inline

tags()

template<typename T >

option_builder & VW::config::option_builder< T >::tags ( std::initializer_list< std::string >  input_tags )

inline

---

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

• /nix/store/2saqbz278bj3pvhbfxlcc50cjbvs3h0h-source/vowpalwabbit/config/include/vw/config/option_builder.h