Stan  2.5.0
probability, sampling & optimization
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
stan::gm::singleton_argument< T > Class Template Reference

#include <singleton_argument.hpp>

Inheritance diagram for stan::gm::singleton_argument< T >:
stan::gm::valued_argument stan::gm::argument stan::gm::arg_adapt_delta stan::gm::arg_adapt_engaged stan::gm::arg_adapt_gamma stan::gm::arg_adapt_init_buffer stan::gm::arg_adapt_kappa stan::gm::arg_adapt_t0 stan::gm::arg_adapt_term_buffer stan::gm::arg_adapt_window stan::gm::arg_data_file stan::gm::arg_diagnostic_file stan::gm::arg_history_size stan::gm::arg_id stan::gm::arg_init stan::gm::arg_init_alpha stan::gm::arg_int_time stan::gm::arg_iter stan::gm::arg_max_depth stan::gm::arg_num_samples stan::gm::arg_num_warmup stan::gm::arg_output_file stan::gm::arg_refresh stan::gm::arg_save_iterations stan::gm::arg_save_warmup stan::gm::arg_seed stan::gm::arg_stepsize stan::gm::arg_stepsize_jitter stan::gm::arg_test_grad_eps stan::gm::arg_test_grad_err stan::gm::arg_thin stan::gm::arg_tolerance

Public Member Functions

 singleton_argument ()
 
 singleton_argument (const std::string name)
 
bool parse_args (std::vector< std::string > &args, std::ostream *out, std::ostream *err, bool &help_flag)
 
virtual void probe_args (argument *base_arg, std::stringstream &s)
 
void find_arg (std::string name, 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::gm::valued_argument
virtual void print (std::ostream *s, const int depth, const std::string prefix)
 
virtual void print_help (std::ostream *s, const int depth, const bool recurse=false)
 
- Public Member Functions inherited from stan::gm::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::gm::valued_argument
std::string _default
 
std::string _value_type
 
- Protected Attributes inherited from stan::gm::argument
std::string _name
 
std::string _description
 
int indent_width
 
int help_width
 

Additional Inherited Members

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

Detailed Description

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

Definition at line 44 of file singleton_argument.hpp.

Constructor & Destructor Documentation

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

Definition at line 48 of file singleton_argument.hpp.

template<typename T >
stan::gm::singleton_argument< T >::singleton_argument ( const std::string  name)
inline

Definition at line 54 of file singleton_argument.hpp.

Member Function Documentation

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

Reimplemented from stan::gm::argument.

Definition at line 116 of file singleton_argument.hpp.

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

Implements stan::gm::valued_argument.

Definition at line 144 of file singleton_argument.hpp.

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

Definition at line 152 of file singleton_argument.hpp.

template<typename T >
bool stan::gm::singleton_argument< T >::parse_args ( std::vector< std::string > &  args,
std::ostream *  out,
std::ostream *  err,
bool &  help_flag 
)
inlinevirtual

Reimplemented from stan::gm::argument.

Definition at line 59 of file singleton_argument.hpp.

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

Implements stan::gm::valued_argument.

Definition at line 140 of file singleton_argument.hpp.

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

Implements stan::gm::valued_argument.

Definition at line 136 of file singleton_argument.hpp.

template<typename T >
virtual void stan::gm::singleton_argument< T >::probe_args ( argument *  base_arg,
std::stringstream &  s 
)
inlinevirtual

Reimplemented from stan::gm::argument.

Definition at line 98 of file singleton_argument.hpp.

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

Definition at line 126 of file singleton_argument.hpp.

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

Definition at line 124 of file singleton_argument.hpp.

Member Data Documentation

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

Definition at line 160 of file singleton_argument.hpp.

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

Definition at line 157 of file singleton_argument.hpp.

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

Definition at line 155 of file singleton_argument.hpp.

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

Definition at line 159 of file singleton_argument.hpp.

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

Definition at line 151 of file singleton_argument.hpp.

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

Definition at line 154 of file singleton_argument.hpp.

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