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::list_argument Class Reference

#include <list_argument.hpp>

Inheritance diagram for stan::gm::list_argument:
stan::gm::valued_argument stan::gm::argument 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

Public Member Functions

 list_argument ()
 
 ~list_argument ()
 
void print (std::ostream *s, int depth, const std::string prefix)
 
void print_help (std::ostream *s, int depth, bool recurse)
 
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)
 
bool valid_value (std::string name)
 
argumentarg (std::string name)
 
std::vector< argument * > & values ()
 
std::string value ()
 
std::string print_value ()
 
std::string print_valid ()
 
bool is_default ()
 
- Public Member Functions inherited from stan::gm::argument
 argument ()
 
 argument (const std::string name)
 
virtual ~argument ()
 
std::string name () const
 
std::string description () const
 
int compute_indent (const int depth)
 

Protected Attributes

int _cursor
 
int _default_cursor
 
std::vector< argument * > _values
 
- 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

Definition at line 12 of file list_argument.hpp.

Constructor & Destructor Documentation

stan::gm::list_argument::list_argument ( )
inline

Definition at line 16 of file list_argument.hpp.

stan::gm::list_argument::~list_argument ( )
inline

Definition at line 20 of file list_argument.hpp.

Member Function Documentation

argument* stan::gm::list_argument::arg ( std::string  name)
inlinevirtual

Reimplemented from stan::gm::argument.

Definition at line 151 of file list_argument.hpp.

void stan::gm::list_argument::find_arg ( std::string  name,
std::string  prefix,
std::vector< std::string > &  valid_paths 
)
inlinevirtual

Reimplemented from stan::gm::argument.

Definition at line 126 of file list_argument.hpp.

bool stan::gm::list_argument::is_default ( )
inlinevirtual

Implements stan::gm::valued_argument.

Definition at line 178 of file list_argument.hpp.

bool stan::gm::list_argument::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 48 of file list_argument.hpp.

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

Reimplemented from stan::gm::valued_argument.

Definition at line 31 of file list_argument.hpp.

void stan::gm::list_argument::print_help ( std::ostream *  s,
int  depth,
bool  recurse 
)
inlinevirtual

Reimplemented from stan::gm::valued_argument.

Definition at line 36 of file list_argument.hpp.

std::string stan::gm::list_argument::print_valid ( )
inlinevirtual

Implements stan::gm::valued_argument.

Definition at line 164 of file list_argument.hpp.

std::string stan::gm::list_argument::print_value ( )
inlinevirtual

Implements stan::gm::valued_argument.

Definition at line 162 of file list_argument.hpp.

virtual void stan::gm::list_argument::probe_args ( argument base_arg,
std::stringstream &  s 
)
inlinevirtual

Reimplemented from stan::gm::argument.

Definition at line 103 of file list_argument.hpp.

bool stan::gm::list_argument::valid_value ( std::string  name)
inline

Definition at line 143 of file list_argument.hpp.

std::string stan::gm::list_argument::value ( )
inline

Definition at line 160 of file list_argument.hpp.

std::vector<argument*>& stan::gm::list_argument::values ( )
inline

Definition at line 158 of file list_argument.hpp.

Member Data Documentation

int stan::gm::list_argument::_cursor
protected

Definition at line 182 of file list_argument.hpp.

int stan::gm::list_argument::_default_cursor
protected

Definition at line 183 of file list_argument.hpp.

std::vector<argument*> stan::gm::list_argument::_values
protected

Definition at line 185 of file list_argument.hpp.


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

     [ Stan Home Page ] © 2011–2014, Stan Development Team.