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

#include <valued_argument.hpp>

Inheritance diagram for stan::gm::valued_argument:
stan::gm::argument stan::gm::list_argument stan::gm::singleton_argument< T > stan::gm::arg_engine stan::gm::arg_method stan::gm::arg_metric stan::gm::arg_optimize_algo stan::gm::arg_sample_algo stan::gm::arg_test 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

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)
 
virtual std::string print_value ()=0
 
virtual std::string print_valid ()=0
 
virtual bool is_default ()=0
 
- 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 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)
 
virtual void find_arg (std::string name, std::string prefix, std::vector< std::string > &valid_paths)
 
virtual argument * arg (const std::string name)
 
int compute_indent (const int depth)
 

Protected Attributes

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

Definition at line 10 of file valued_argument.hpp.

Member Function Documentation

virtual bool stan::gm::valued_argument::is_default ( )
pure virtual

Implemented in stan::gm::list_argument, and stan::gm::singleton_argument< T >.

virtual void stan::gm::valued_argument::print ( std::ostream *  s,
const int  depth,
const std::string  prefix 
)
inlinevirtual

Implements stan::gm::argument.

Reimplemented in stan::gm::list_argument.

Definition at line 14 of file valued_argument.hpp.

virtual void stan::gm::valued_argument::print_help ( std::ostream *  s,
const int  depth,
const bool  recurse = false 
)
inlinevirtual

Implements stan::gm::argument.

Reimplemented in stan::gm::list_argument.

Definition at line 26 of file valued_argument.hpp.

virtual std::string stan::gm::valued_argument::print_valid ( )
pure virtual

Implemented in stan::gm::list_argument, and stan::gm::singleton_argument< T >.

virtual std::string stan::gm::valued_argument::print_value ( )
pure virtual

Implemented in stan::gm::list_argument, and stan::gm::singleton_argument< T >.

Member Data Documentation

std::string stan::gm::valued_argument::_default
protected

Definition at line 47 of file valued_argument.hpp.

std::string stan::gm::valued_argument::_value_type
protected

Definition at line 48 of file valued_argument.hpp.

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