VW::config::typed_option< T > Struct Template Reference

#include <options.h>

Inheritance diagram for VW::config::typed_option< T >:

Public Member Functions
	typed_option (const std::string &name, T &location)
typed_option &	default_value (T value)
bool	default_value_supplied () const
T	default_value () const
typed_option &	short_name (const std::string &short_name)
typed_option &	help (const std::string &help)
typed_option &	keep (bool keep=true)
typed_option &	necessary (bool necessary=true)
typed_option &	allow_override (bool allow_override=true)
bool	value_supplied () const
typed_option &	value (T value)
T	value () const
Public Member Functions inherited from VW::config::base_option
	base_option (std::string name, size_t type_hash)
virtual	~base_option ()=default

Static Public Member Functions
static size_t	type_hash ()

Public Attributes
T &	m_location
Public Attributes inherited from VW::config::base_option
std::string	m_name
size_t	m_type_hash
std::string	m_help = ""
std::string	m_short_name = ""
bool	m_keep = false
bool	m_necessary = false
bool	m_allow_override = false

Constructor & Destructor Documentation

template<typename T>

VW::config::typed_option< T >::typed_option ( const std::string &  name, T &  location  )

inline

Member Function Documentation

template<typename T>

typed_option& VW::config::typed_option< T >::allow_override ( bool  allow_override = true )

inline

template<typename T>

typed_option& VW::config::typed_option< T >::default_value ( T  value )

inline

template<typename T>

T VW::config::typed_option< T >::default_value ( ) const

inline

template<typename T>

bool VW::config::typed_option< T >::default_value_supplied ( ) const

inline

template<typename T>

typed_option& VW::config::typed_option< T >::help ( const std::string &  help )

inline

template<typename T>

typed_option& VW::config::typed_option< T >::keep ( bool  keep = true )

inline

template<typename T>

typed_option& VW::config::typed_option< T >::necessary ( bool  necessary = true )

inline

template<typename T>

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

inline

template<typename T>

static size_t VW::config::typed_option< T >::type_hash ( )

inlinestatic

template<typename T>

typed_option& VW::config::typed_option< T >::value ( T  value )

inline

template<typename T>

T VW::config::typed_option< T >::value ( ) const

inline

template<typename T>

bool VW::config::typed_option< T >::value_supplied ( ) const

inline

Member Data Documentation

template<typename T>

T& VW::config::typed_option< T >::m_location

---

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

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