Stan  2.10.0
probability, sampling & optimization
Classes | Functions
stan::io Namespace Reference

Input/output utilities. More...

Classes

class  array_var_context
 An array_var_context object represents a named arrays with dimensions constructed from an array, a vector of names, and a vector of all dimensions for each element. More...
 
class  chained_var_context
 A chained_var_context object represents two objects of var_context as one. More...
 
class  cmd_line
 Parses and stores command-line arguments. More...
 
class  dump
 Represents named arrays with dimensions. More...
 
class  dump_reader
 Reads data from S-plus dump format. More...
 
class  reader
 A stream-based reader for integer, scalar, vector, matrix and array data types, with Jacobian calculations. More...
 
struct  stan_csv
 
struct  stan_csv_adaptation
 
struct  stan_csv_metadata
 
class  stan_csv_reader
 Reads from a Stan output csv file. More...
 
struct  stan_csv_timing
 
class  var_context
 A var_reader reads array variables of integer and floating point type by name and dimension. More...
 
class  writer
 A stream-based writer for integer, scalar, vector, matrix and array data types, which transforms from constrained to a sequence of constrained variables. More...
 

Functions

void pad_help_option (std::ostream *o, const std::string &option="", unsigned int width=20)
 Print help option with padding. More...
 
void print_help_helper (std::ostream *o, const std::string &key_val, const std::string &msg, const std::string &note="")
 Prints single print option to output ptr if non-null. More...
 
void print_help_option (std::ostream *o, const std::string &key, const std::string &value_type, const std::string &msg, const std::string &note="")
 Prints single print option to output ptr if non-null. More...
 
template<>
bool cmd_line::bare< std::string > (size_t n, std::string &x) const
 
template<>
bool cmd_line::val< std::string > (const std::string &key, std::string &x) const
 
std::string utc_time_string ()
 Return the current coordinated universal time (UTC) as a string. More...
 
template<typename B >
void validate_zero_buf (const B &buf)
 Throw an bad-cast exception if the specified buffer contains a digit other than 0 before an e or E. More...
 

Detailed Description

Input/output utilities.

Function Documentation

template<>
bool stan::io::cmd_line::bare< std::string > ( size_t  n,
std::string &  x 
) const

Definition at line 275 of file cmd_line.hpp.

template<>
bool stan::io::cmd_line::val< std::string > ( const std::string &  key,
std::string &  x 
) const

Definition at line 285 of file cmd_line.hpp.

void stan::io::pad_help_option ( std::ostream *  o,
const std::string &  option = "",
unsigned int  width = 20 
)

Print help option with padding.

Print 2 spaces, the specified help option, then pad to the specified width with spaces. If there is not room for at least 2 padding spaces, start a new line and pad out to width.

Parameters
optionOption to print (default to empty string).
widthWidth of option (defaults to 20).
oOutput stream ptr, default to null

Definition at line 27 of file cmd_line.hpp.

void stan::io::print_help_helper ( std::ostream *  o,
const std::string &  key_val,
const std::string &  msg,
const std::string &  note = "" 
)

Prints single print option to output ptr if non-null.

Parameters
o
key_val
msg
note

Definition at line 49 of file cmd_line.hpp.

void stan::io::print_help_option ( std::ostream *  o,
const std::string &  key,
const std::string &  value_type,
const std::string &  msg,
const std::string &  note = "" 
)

Prints single print option to output ptr if non-null.

Parameters
o
key
value_type
msg
note

Definition at line 74 of file cmd_line.hpp.

std::string stan::io::utc_time_string ( )

Return the current coordinated universal time (UTC) as a string.

Output is of the form "Fri Feb 24 21:15:36 2012"

Returns
String representation of current UTC.

Definition at line 18 of file util.hpp.

template<typename B >
void stan::io::validate_zero_buf ( const B &  buf)

Throw an bad-cast exception if the specified buffer contains a digit other than 0 before an e or E.

The buffer argument must implement size_t size() method and char operator[](size_t).

Template Parameters
BCharacter buffer type
Exceptions
<code>boost::bad_lexical_cast</code>if the buffer contains non-zero characters before an exponentiation symbol.

Definition at line 21 of file validate_zero_buf.hpp.


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