Stan  2.10.0
probability, sampling & optimization
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
stan::services::argument Class Referenceabstract

#include <argument.hpp>

Inheritance diagram for stan::services::argument:
stan::services::categorical_argument stan::services::unvalued_argument stan::services::valued_argument stan::services::arg_adapt stan::services::arg_bfgs stan::services::arg_data stan::services::arg_diagnose stan::services::arg_hmc stan::services::arg_newton stan::services::arg_nuts stan::services::arg_optimize stan::services::arg_output stan::services::arg_random stan::services::arg_rwm stan::services::arg_sample stan::services::arg_softabs stan::services::arg_static stan::services::arg_test_gradient stan::services::arg_variational stan::services::arg_variational_adapt stan::services::arg_variational_fullrank stan::services::arg_variational_meanfield stan::services::arg_xhmc stan::services::arg_dense_e stan::services::arg_diag_e stan::services::arg_fail stan::services::arg_fixed_param stan::services::arg_unit_e stan::services::list_argument stan::services::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 (interface_callbacks::writer::base_writer &w, const int depth, const std::string &prefix)=0
 
virtual void print_help (interface_callbacks::writer::base_writer &w, const int depth, const bool recurse)=0
 
virtual 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, interface_callbacks::writer::base_writer &w)
 
virtual void find_arg (const std::string &name, const std::string &prefix, std::vector< std::string > &valid_paths)
 
virtual argumentarg (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 13 of file argument.hpp.

Constructor & Destructor Documentation

stan::services::argument::argument ( )
inline

Definition at line 15 of file argument.hpp.

stan::services::argument::argument ( const std::string &  name)
inlineexplicit

Definition at line 19 of file argument.hpp.

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

Definition at line 24 of file argument.hpp.

Member Function Documentation

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

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

Definition at line 74 of file argument.hpp.

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

Definition at line 78 of file argument.hpp.

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

Definition at line 30 of file argument.hpp.

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

Definition at line 26 of file argument.hpp.

virtual bool stan::services::argument::parse_args ( std::vector< std::string > &  args,
interface_callbacks::writer::base_writer info,
interface_callbacks::writer::base_writer err,
bool &  help_flag 
)
inlinevirtual
virtual void stan::services::argument::print ( interface_callbacks::writer::base_writer w,
const int  depth,
const std::string &  prefix 
)
pure virtual
virtual void stan::services::argument::print_help ( interface_callbacks::writer::base_writer w,
const int  depth,
const bool  recurse 
)
pure virtual
virtual void stan::services::argument::probe_args ( argument base_arg,
interface_callbacks::writer::base_writer w 
)
inlinevirtual
static void stan::services::argument::split_arg ( const std::string &  arg,
std::string &  name,
std::string &  value 
)
inlinestatic

Definition at line 60 of file argument.hpp.

Member Data Documentation

std::string stan::services::argument::_description
protected

Definition at line 84 of file argument.hpp.

std::string stan::services::argument::_name
protected

Definition at line 83 of file argument.hpp.

int stan::services::argument::help_width
protected

Definition at line 87 of file argument.hpp.

int stan::services::argument::indent_width
protected

Definition at line 86 of file argument.hpp.


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

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