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

#include <argument.hpp>

Inheritance diagram for stan::gm::argument:
stan::gm::categorical_argument stan::gm::unvalued_argument stan::gm::valued_argument stan::gm::arg_adapt stan::gm::arg_bfgs stan::gm::arg_data stan::gm::arg_diagnose stan::gm::arg_hmc stan::gm::arg_newton stan::gm::arg_nuts stan::gm::arg_optimize stan::gm::arg_output stan::gm::arg_random stan::gm::arg_rwm stan::gm::arg_sample stan::gm::arg_static stan::gm::arg_test_gradient stan::gm::arg_dense_e stan::gm::arg_diag_e stan::gm::arg_fail stan::gm::arg_fixed_param stan::gm::arg_unit_e stan::gm::list_argument stan::gm::singleton_argument< T >

Public Member Functions

 argument ()
 
 argument (const std::string name)
 
virtual ~argument ()
 
std::string name () const
 
std::string description () const
 
virtual void print (std::ostream *s, const int depth, const std::string prefix)=0
 
virtual void print_help (std::ostream *s, const int depth, const bool recurse)=0
 
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)
 

Static Public Member Functions

static void split_arg (const std::string &arg, std::string &name, std::string &value)
 

Protected Attributes

std::string _name
 
std::string _description
 
int indent_width
 
int help_width
 

Detailed Description

Definition at line 12 of file argument.hpp.

Constructor & Destructor Documentation

stan::gm::argument::argument ( )
inline

Definition at line 15 of file argument.hpp.

stan::gm::argument::argument ( const std::string  name)
inline

Definition at line 19 of file argument.hpp.

virtual stan::gm::argument::~argument ( )
inlinevirtual

Definition at line 24 of file argument.hpp.

Member Function Documentation

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

Reimplemented in stan::gm::list_argument, and stan::gm::categorical_argument.

Definition at line 67 of file argument.hpp.

int stan::gm::argument::compute_indent ( const int  depth)
inline

Definition at line 71 of file argument.hpp.

std::string stan::gm::argument::description ( ) const
inline

Definition at line 30 of file argument.hpp.

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

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

Definition at line 46 of file argument.hpp.

std::string stan::gm::argument::name ( ) const
inline

Definition at line 26 of file argument.hpp.

virtual bool stan::gm::argument::parse_args ( std::vector< std::string > &  args,
std::ostream *  out,
std::ostream *  err,
bool &  help_flag 
)
inlinevirtual

Reimplemented in stan::gm::categorical_argument, stan::gm::singleton_argument< T >, stan::gm::list_argument, and stan::gm::unvalued_argument.

Definition at line 37 of file argument.hpp.

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

Implemented in stan::gm::list_argument, stan::gm::categorical_argument, stan::gm::unvalued_argument, and stan::gm::valued_argument.

virtual void stan::gm::argument::print_help ( std::ostream *  s,
const int  depth,
const bool  recurse 
)
pure virtual

Implemented in stan::gm::list_argument, stan::gm::categorical_argument, stan::gm::valued_argument, and stan::gm::unvalued_argument.

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

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

Definition at line 44 of file argument.hpp.

static void stan::gm::argument::split_arg ( const std::string &  arg,
std::string &  name,
std::string &  value 
)
inlinestatic

Definition at line 54 of file argument.hpp.

Member Data Documentation

std::string stan::gm::argument::_description
protected

Definition at line 77 of file argument.hpp.

std::string stan::gm::argument::_name
protected

Definition at line 76 of file argument.hpp.

int stan::gm::argument::help_width
protected

Definition at line 80 of file argument.hpp.

int stan::gm::argument::indent_width
protected

Definition at line 79 of file argument.hpp.

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