Stan  2.14.0
probability, sampling & optimization
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
stan::services::singleton_argument< T > Class Template Reference

#include <singleton_argument.hpp>

Inheritance diagram for stan::services::singleton_argument< T >:
stan::services::valued_argument stan::services::argument stan::services::arg_adapt_delta stan::services::arg_adapt_engaged stan::services::arg_adapt_gamma stan::services::arg_adapt_init_buffer stan::services::arg_adapt_kappa stan::services::arg_adapt_t0 stan::services::arg_adapt_term_buffer stan::services::arg_adapt_window stan::services::arg_data_file stan::services::arg_diagnostic_file stan::services::arg_history_size stan::services::arg_id stan::services::arg_init stan::services::arg_init_alpha stan::services::arg_int_time stan::services::arg_iter stan::services::arg_max_depth stan::services::arg_num_samples stan::services::arg_num_warmup stan::services::arg_output_file stan::services::arg_refresh stan::services::arg_save_iterations stan::services::arg_save_warmup stan::services::arg_seed stan::services::arg_softabs_alpha stan::services::arg_stepsize stan::services::arg_stepsize_jitter stan::services::arg_test_grad_eps stan::services::arg_test_grad_err stan::services::arg_thin stan::services::arg_tolerance stan::services::arg_variational_adapt_engaged stan::services::arg_variational_adapt_iter stan::services::arg_variational_eta stan::services::arg_variational_eval_elbo stan::services::arg_variational_iter stan::services::arg_variational_num_samples stan::services::arg_variational_output_samples stan::services::arg_x_delta

Public Member Functions

 singleton_argument ()
 
 singleton_argument (const std::string name)
 
bool parse_args (std::vector< std::string > &args, interface_callbacks::writer::base_writer &info, interface_callbacks::writer::base_writer &err, bool &help_flag)
 
virtual void probe_args (argument *base_arg, stan::interface_callbacks::writer::base_writer &w)
 
void find_arg (const std::string &name, const std::string &prefix, std::vector< std::string > &valid_paths)
 
T value ()
 
bool set_value (const T &value)
 
std::string print_value ()
 
std::string print_valid ()
 
bool is_default ()
 
- Public Member Functions inherited from stan::services::valued_argument
virtual void print (interface_callbacks::writer::base_writer &w, const int depth, const std::string &prefix)
 
virtual void print_help (interface_callbacks::writer::base_writer &w, const int depth, const bool recurse=false)
 
- Public Member Functions inherited from stan::services::argument
 argument ()
 
 argument (const std::string &name)
 
virtual ~argument ()
 
std::string name () const
 
std::string description () const
 
virtual argument * arg (const std::string &name)
 
int compute_indent (const int depth)
 

Protected Member Functions

virtual bool is_valid (T value)
 

Protected Attributes

std::string _validity
 
T _value
 
T _default_value
 
bool _constrained
 
T _good_value
 
T _bad_value
 
- Protected Attributes inherited from stan::services::valued_argument
std::string _default
 
std::string _value_type
 
- Protected Attributes inherited from stan::services::argument
std::string _name
 
std::string _description
 
int indent_width
 
int help_width
 

Additional Inherited Members

- Static Public Member Functions inherited from stan::services::argument
static void split_arg (const std::string &arg, std::string &name, std::string &value)
 

Detailed Description

template<typename T>
class stan::services::singleton_argument< T >

Definition at line 45 of file singleton_argument.hpp.

Constructor & Destructor Documentation

§ singleton_argument() [1/2]

template<typename T >
stan::services::singleton_argument< T >::singleton_argument ( )
inline

Definition at line 47 of file singleton_argument.hpp.

§ singleton_argument() [2/2]

template<typename T >
stan::services::singleton_argument< T >::singleton_argument ( const std::string  name)
inlineexplicit

Definition at line 53 of file singleton_argument.hpp.

Member Function Documentation

§ find_arg()

template<typename T >
void stan::services::singleton_argument< T >::find_arg ( const std::string &  name,
const std::string &  prefix,
std::vector< std::string > &  valid_paths 
)
inlinevirtual

Reimplemented from stan::services::argument.

Definition at line 113 of file singleton_argument.hpp.

§ is_default()

template<typename T >
bool stan::services::singleton_argument< T >::is_default ( )
inlinevirtual

Implements stan::services::valued_argument.

Definition at line 139 of file singleton_argument.hpp.

§ is_valid()

template<typename T >
virtual bool stan::services::singleton_argument< T >::is_valid ( T  value)
inlineprotectedvirtual

Definition at line 145 of file singleton_argument.hpp.

§ parse_args()

template<typename T >
bool stan::services::singleton_argument< T >::parse_args ( std::vector< std::string > &  args,
interface_callbacks::writer::base_writer &  info,
interface_callbacks::writer::base_writer &  err,
bool &  help_flag 
)
inlinevirtual

Reimplemented from stan::services::argument.

Definition at line 57 of file singleton_argument.hpp.

§ print_valid()

template<typename T >
std::string stan::services::singleton_argument< T >::print_valid ( )
inlinevirtual

Implements stan::services::valued_argument.

Definition at line 135 of file singleton_argument.hpp.

§ print_value()

template<typename T >
std::string stan::services::singleton_argument< T >::print_value ( )
inlinevirtual

Implements stan::services::valued_argument.

Definition at line 131 of file singleton_argument.hpp.

§ probe_args()

template<typename T >
virtual void stan::services::singleton_argument< T >::probe_args ( argument *  base_arg,
stan::interface_callbacks::writer::base_writer &  w 
)
inlinevirtual

Reimplemented from stan::services::argument.

Definition at line 96 of file singleton_argument.hpp.

§ set_value()

template<typename T >
bool stan::services::singleton_argument< T >::set_value ( const T &  value)
inline

Definition at line 123 of file singleton_argument.hpp.

§ value()

template<typename T >
T stan::services::singleton_argument< T >::value ( )
inline

Definition at line 121 of file singleton_argument.hpp.

Member Data Documentation

§ _bad_value

template<typename T >
T stan::services::singleton_argument< T >::_bad_value
protected

Definition at line 153 of file singleton_argument.hpp.

§ _constrained

template<typename T >
bool stan::services::singleton_argument< T >::_constrained
protected

Definition at line 150 of file singleton_argument.hpp.

§ _default_value

template<typename T >
T stan::services::singleton_argument< T >::_default_value
protected

Definition at line 148 of file singleton_argument.hpp.

§ _good_value

template<typename T >
T stan::services::singleton_argument< T >::_good_value
protected

Definition at line 152 of file singleton_argument.hpp.

§ _validity

template<typename T >
std::string stan::services::singleton_argument< T >::_validity
protected

Definition at line 144 of file singleton_argument.hpp.

§ _value

template<typename T >
T stan::services::singleton_argument< T >::_value
protected

Definition at line 147 of file singleton_argument.hpp.

The documentation for this class was generated from the following file:
     [ Stan Home Page ] © 2011–2016, Stan Development Team.