Stan  2.10.0
probability, sampling & optimization
Public Member Functions | List of all members
stan::interface_callbacks::writer::base_writer Class Referenceabstract

base_writer is an abstract base class defining the interface for Stan writer callbacks. More...

#include <base_writer.hpp>

Inheritance diagram for stan::interface_callbacks::writer::base_writer:
stan::interface_callbacks::writer::noop_writer stan::interface_callbacks::writer::stream_writer

Public Member Functions

virtual void operator() (const std::string &key, double value)=0
 Writes a key, value pair. More...
 
virtual void operator() (const std::string &key, int value)=0
 Writes a key, value pair. More...
 
virtual void operator() (const std::string &key, const std::string &value)=0
 Writes a key, value pair. More...
 
virtual void operator() (const std::string &key, const double *values, int n_values)=0
 Writes a key, value pair. More...
 
virtual void operator() (const std::string &key, const double *values, int n_rows, int n_cols)=0
 Writes a key, value pair. More...
 
virtual void operator() (const std::vector< std::string > &names)=0
 Writes a set of names. More...
 
virtual void operator() (const std::vector< double > &state)=0
 Writes a set of values. More...
 
virtual void operator() ()=0
 Writes blank input. More...
 
virtual void operator() (const std::string &message)=0
 Writes a string. More...
 
virtual ~base_writer ()
 Destructor. More...
 

Detailed Description

base_writer is an abstract base class defining the interface for Stan writer callbacks.

The Stan API writes structured output to implementations of this class defined by a given interface.

Definition at line 20 of file base_writer.hpp.

Constructor & Destructor Documentation

virtual stan::interface_callbacks::writer::base_writer::~base_writer ( )
inlinevirtual

Destructor.

Virtual destructor to avoid compiler warnings

Definition at line 107 of file base_writer.hpp.

Member Function Documentation

virtual void stan::interface_callbacks::writer::base_writer::operator() ( const std::string &  key,
double  value 
)
pure virtual

Writes a key, value pair.

Parameters
[in]keyA string
[in]valueA double value

Implemented in stan::interface_callbacks::writer::stream_writer, and stan::interface_callbacks::writer::noop_writer.

virtual void stan::interface_callbacks::writer::base_writer::operator() ( const std::string &  key,
int  value 
)
pure virtual

Writes a key, value pair.

Parameters
[in]keyA string
[in]valueAn integer value

Implemented in stan::interface_callbacks::writer::stream_writer, and stan::interface_callbacks::writer::noop_writer.

virtual void stan::interface_callbacks::writer::base_writer::operator() ( const std::string &  key,
const std::string &  value 
)
pure virtual

Writes a key, value pair.

Parameters
[in]keyA string
[in]valueA string

Implemented in stan::interface_callbacks::writer::stream_writer, and stan::interface_callbacks::writer::noop_writer.

virtual void stan::interface_callbacks::writer::base_writer::operator() ( const std::string &  key,
const double *  values,
int  n_values 
)
pure virtual

Writes a key, value pair.

Parameters
[in]keyA string
[in]valuesA double array, typically used with contiguous Eigen vectors
[in]n_valuesLength of the array

Implemented in stan::interface_callbacks::writer::stream_writer, and stan::interface_callbacks::writer::noop_writer.

virtual void stan::interface_callbacks::writer::base_writer::operator() ( const std::string &  key,
const double *  values,
int  n_rows,
int  n_cols 
)
pure virtual

Writes a key, value pair.

Parameters
[in]keyA string
[in]valuesA double array assumed to represent a 2d matrix stored in column major order, typically used with contiguous Eigen matrices
[in]n_rowsRows
[in]n_colsColumns

Implemented in stan::interface_callbacks::writer::stream_writer, and stan::interface_callbacks::writer::noop_writer.

virtual void stan::interface_callbacks::writer::base_writer::operator() ( const std::vector< std::string > &  names)
pure virtual

Writes a set of names.

Parameters
[in]namesNames in a std::vector

Implemented in stan::interface_callbacks::writer::stream_writer, and stan::interface_callbacks::writer::noop_writer.

virtual void stan::interface_callbacks::writer::base_writer::operator() ( const std::vector< double > &  state)
pure virtual

Writes a set of values.

Parameters
[in]stateValues in a std::vector

Implemented in stan::interface_callbacks::writer::stream_writer, and stan::interface_callbacks::writer::noop_writer.

virtual void stan::interface_callbacks::writer::base_writer::operator() ( )
pure virtual
virtual void stan::interface_callbacks::writer::base_writer::operator() ( const std::string &  message)
pure virtual

Writes a string.

Parameters
[in]messageA string

Implemented in stan::interface_callbacks::writer::stream_writer, and stan::interface_callbacks::writer::noop_writer.


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

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