stan::services::sample::mcmc_writer< Model, SampleWriter, DiagnosticWriter, MessageWriter > Class Template Reference

mcmc_writer writes out headers and samples More...

#include <mcmc_writer.hpp>

Public Member Functions
	mcmc_writer (SampleWriter &sample_writer, DiagnosticWriter &diagnostic_writer, MessageWriter &message_writer)
	Constructor. More...
void	write_sample_names (stan::mcmc::sample &sample, stan::mcmc::base_mcmc *sampler, Model &model)
	Outputs parameter string names. More...
template<class RNG >
void	write_sample_params (RNG &rng, stan::mcmc::sample &sample, stan::mcmc::base_mcmc &sampler, Model &model)
	Outputs samples. More...
void	write_adapt_finish (stan::mcmc::base_mcmc *sampler)
	Prints additional info to the streams. More...
void	write_diagnostic_names (stan::mcmc::sample sample, stan::mcmc::base_mcmc *sampler, Model &model)
	Print diagnostic names. More...
void	write_diagnostic_params (stan::mcmc::sample &sample, stan::mcmc::base_mcmc *sampler)
	Print diagnostic params to the diagnostic stream. More...
template<class Writer >
void	write_timing (double warmDeltaT, double sampleDeltaT, Writer &writer)
	Internal method. More...
void	write_timing (double warmDeltaT, double sampleDeltaT)
	Print timing information to all streams. More...

Detailed Description

template<class Model, class SampleWriter, class DiagnosticWriter, class MessageWriter>
class stan::services::sample::mcmc_writer< Model, SampleWriter, DiagnosticWriter, MessageWriter >

mcmc_writer writes out headers and samples

Template Parameters

Model	Model class
SampleWriter	Class for recording samples
DiagnosticWriter	Class for diagnostic samples

Definition at line 26 of file mcmc_writer.hpp.

Constructor & Destructor Documentation

mcmc_writer()

template<class Model , class SampleWriter , class DiagnosticWriter , class MessageWriter >

stan::services::sample::mcmc_writer< Model, SampleWriter, DiagnosticWriter, MessageWriter >::mcmc_writer ( SampleWriter &  sample_writer, DiagnosticWriter &  diagnostic_writer, MessageWriter &  message_writer  )

inline

Constructor.

Parameters

sample_writer	samples are "written" to this stream (can abstract this?)
diagnostic_writer	diagnostic information is "written" to this stream
message_writer	messages are written to this stream

Precondition

arguments == 0 if and only if they are not meant to be used

Postcondition

none

Side effects: streams are stored in this object

Definition at line 44 of file mcmc_writer.hpp.

Member Function Documentation

write_adapt_finish()

template<class Model , class SampleWriter , class DiagnosticWriter , class MessageWriter >

void stan::services::sample::mcmc_writer< Model, SampleWriter, DiagnosticWriter, MessageWriter >::write_adapt_finish ( stan::mcmc::base_mcmc *  sampler )

inline

Prints additional info to the streams.

Prints to the sample stream

Parameters

sampler

sampler

Definition at line 131 of file mcmc_writer.hpp.

write_diagnostic_names()

template<class Model , class SampleWriter , class DiagnosticWriter , class MessageWriter >

void stan::services::sample::mcmc_writer< Model, SampleWriter, DiagnosticWriter, MessageWriter >::write_diagnostic_names ( stan::mcmc::sample  sample, stan::mcmc::base_mcmc *  sampler, Model &  model  )

inline

Print diagnostic names.

Parameters

sample	unconstrained sample
sampler	sampler
model	model

Precondition

sample, sampler, and model are consistent.

Postcondition

none

Side effects: diagnostic_stream_ is appended with comma

separated names with newline at the end

Definition at line 149 of file mcmc_writer.hpp.

write_diagnostic_params()

template<class Model , class SampleWriter , class DiagnosticWriter , class MessageWriter >

void stan::services::sample::mcmc_writer< Model, SampleWriter, DiagnosticWriter, MessageWriter >::write_diagnostic_params ( stan::mcmc::sample &  sample, stan::mcmc::base_mcmc *  sampler  )

inline

Print diagnostic params to the diagnostic stream.

Parameters

sample	unconstrained sample
sampler	sampler

Precondition

sample and sampler are consistent

Postcondition

none.

Side effects: diagnostic_stream_ is appended with csv values of the

sample's get_sample_params(), the sampler's get_sampler_params(), and get_sampler_diagnostics()

Definition at line 177 of file mcmc_writer.hpp.

write_sample_names()

template<class Model , class SampleWriter , class DiagnosticWriter , class MessageWriter >

void stan::services::sample::mcmc_writer< Model, SampleWriter, DiagnosticWriter, MessageWriter >::write_sample_names ( stan::mcmc::sample &  sample, stan::mcmc::base_mcmc *  sampler, Model &  model  )

inline

Outputs parameter string names.

First outputs the names stored in the sample object (stan::mcmc::sample), then uses the sampler provided to output sampler specific names, then adds the model constrained parameter names.

The names are written to the sample_stream as comma separated values with a newline at the end.

Parameters

sample	a sample (unconstrained) that works with the model
sampler	a stan::mcmc::base_mcmc object
model	the model

Precondition

none

Postcondition

none

Side effects: sample_stream_ is written to with comma separated values

with a newline at the end

Definition at line 70 of file mcmc_writer.hpp.

write_sample_params()

template<class Model , class SampleWriter , class DiagnosticWriter , class MessageWriter >

template<class RNG >

void stan::services::sample::mcmc_writer< Model, SampleWriter, DiagnosticWriter, MessageWriter >::write_sample_params ( RNG &  rng, stan::mcmc::sample &  sample, stan::mcmc::base_mcmc &  sampler, Model &  model  )

inline

Outputs samples.

First outputs the values of the sample params from a stan::mcmc::sample, then outputs the values of the sampler params from a stan::mcmc::base_mcmc, then finally outputs the values of the model.

The samples are written to the sample_stream as comma separated values with a newline at the end.

Parameters

rng	random number generator (used by model.write_array())
sample	the sample in constrained space
sampler	the sampler
model	the model

Definition at line 98 of file mcmc_writer.hpp.

write_timing() [1/2]

template<class Model , class SampleWriter , class DiagnosticWriter , class MessageWriter >

template<class Writer >

void stan::services::sample::mcmc_writer< Model, SampleWriter, DiagnosticWriter, MessageWriter >::write_timing ( double  warmDeltaT, double  sampleDeltaT, Writer &  writer  )

inline

Internal method.

Prints timing information

Parameters

warmDeltaT	warmup time in seconds
sampleDeltaT	sample time in seconds
writer	output stream

Precondition

none

Postcondition

none

Side effects: stream is updated with information about timing

Definition at line 204 of file mcmc_writer.hpp.

write_timing() [2/2]

template<class Model , class SampleWriter , class DiagnosticWriter , class MessageWriter >

void stan::services::sample::mcmc_writer< Model, SampleWriter, DiagnosticWriter, MessageWriter >::write_timing ( double  warmDeltaT, double  sampleDeltaT  )

inline

Print timing information to all streams.

Parameters

warmDeltaT	warmup time (sec)
sampleDeltaT	sample time (sec)

Definition at line 237 of file mcmc_writer.hpp.

---

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

• src/stan/services/sample/mcmc_writer.hpp