Stan  2.14.0
probability, sampling & optimization
Public Member Functions | Protected Attributes | List of all members
stan::services::list_argument Class Reference

#include <list_argument.hpp>

Inheritance diagram for stan::services::list_argument:
stan::services::valued_argument stan::services::argument stan::services::arg_engine stan::services::arg_method stan::services::arg_metric stan::services::arg_optimize_algo stan::services::arg_sample_algo stan::services::arg_test stan::services::arg_variational_algo

Public Member Functions

 list_argument ()
 
 ~list_argument ()
 
void print (interface_callbacks::writer::base_writer &w, int depth, const std::string &prefix)
 
void print_help (interface_callbacks::writer::base_writer &w, int depth, bool recurse)
 
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, stan::interface_callbacks::writer::base_writer &w)
 
void find_arg (const std::string &name, const std::string &prefix, std::vector< std::string > &valid_paths)
 
bool valid_value (const std::string &name)
 
argument * arg (const 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::services::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::services::valued_argument
std::string _default
 
std::string _value_type
 
- Protected Attributes inherited from stan::services::argument
std::string _name
 
std::string _description
 
int indent_width
 
int help_width
 

Additional Inherited Members

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

Detailed Description

Definition at line 14 of file list_argument.hpp.

Constructor & Destructor Documentation

§ list_argument()

stan::services::list_argument::list_argument ( )
inline

Definition at line 16 of file list_argument.hpp.

§ ~list_argument()

stan::services::list_argument::~list_argument ( )
inline

Definition at line 20 of file list_argument.hpp.

Member Function Documentation

§ arg()

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

Reimplemented from stan::services::argument.

Definition at line 146 of file list_argument.hpp.

§ find_arg()

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

Reimplemented from stan::services::argument.

Definition at line 124 of file list_argument.hpp.

§ is_default()

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

Implements stan::services::valued_argument.

Definition at line 172 of file list_argument.hpp.

§ parse_args()

bool stan::services::list_argument::parse_args ( std::vector< std::string > &  args,
interface_callbacks::writer::base_writer &  info,
interface_callbacks::writer::base_writer &  err,
bool &  help_flag 
)
inlinevirtual

Reimplemented from stan::services::argument.

Definition at line 50 of file list_argument.hpp.

§ print()

void stan::services::list_argument::print ( interface_callbacks::writer::base_writer &  w,
int  depth,
const std::string &  prefix 
)
inlinevirtual

Reimplemented from stan::services::valued_argument.

Definition at line 29 of file list_argument.hpp.

§ print_help()

void stan::services::list_argument::print_help ( interface_callbacks::writer::base_writer &  w,
int  depth,
bool  recurse 
)
inlinevirtual

Reimplemented from stan::services::valued_argument.

Definition at line 36 of file list_argument.hpp.

§ print_valid()

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

Implements stan::services::valued_argument.

Definition at line 159 of file list_argument.hpp.

§ print_value()

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

Implements stan::services::valued_argument.

Definition at line 157 of file list_argument.hpp.

§ probe_args()

virtual void stan::services::list_argument::probe_args ( argument *  base_arg,
stan::interface_callbacks::writer::base_writer &  w 
)
inlinevirtual

Reimplemented from stan::services::argument.

Definition at line 102 of file list_argument.hpp.

§ valid_value()

bool stan::services::list_argument::valid_value ( const std::string &  name)
inline

Definition at line 138 of file list_argument.hpp.

§ value()

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

Definition at line 155 of file list_argument.hpp.

§ values()

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

Definition at line 153 of file list_argument.hpp.

Member Data Documentation

§ _cursor

int stan::services::list_argument::_cursor
protected

Definition at line 175 of file list_argument.hpp.

§ _default_cursor

int stan::services::list_argument::_default_cursor
protected

Definition at line 176 of file list_argument.hpp.

§ _values

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

Definition at line 178 of file list_argument.hpp.

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