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

#include <options.h>

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

Public Types

using value_type = T
 

Public Member Functions

 typed_option (const std::string &name)
 
void set_default_value (const value_type &value)
 
bool default_value_supplied () const
 
default_value () const
 
bool value_supplied () const
 
typed_optionvalue (T value, bool called_from_add_and_parse=false)
 
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 ()
 

Protected Member Functions

virtual void value_set_callback (const T &, bool)
 

Additional Inherited Members

- 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
 

Member Typedef Documentation

template<typename T>
using VW::config::typed_option< T >::value_type = T

Constructor & Destructor Documentation

template<typename T>
VW::config::typed_option< T >::typed_option ( const std::string &  name)
inline

Member Function Documentation

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>
void VW::config::typed_option< T >::set_default_value ( const value_type value)
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 ( value,
bool  called_from_add_and_parse = false 
)
inline
template<typename T>
T VW::config::typed_option< T >::value ( ) const
inline
template<typename T>
virtual void VW::config::typed_option< T >::value_set_callback ( const T &  ,
bool   
)
inlineprotectedvirtual
template<typename T>
bool VW::config::typed_option< T >::value_supplied ( ) const
inline

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