A stream-based writer for integer, scalar, vector, matrix and array data types, which transforms from constrained to a sequence of constrained variables. More...

#include <writer.hpp>

Public Types
typedef Eigen::Matrix< T, Eigen::Dynamic, Eigen::Dynamic >	matrix_t

typedef Eigen::Matrix< T, Eigen::Dynamic, 1 >	vector_t

typedef Eigen::Matrix< T, 1, Eigen::Dynamic >	row_vector_t

typedef Eigen::Array< T, Eigen::Dynamic, 1 >	array_vec_t

Public Member Functions
	writer (std::vector< T > &data_r, std::vector< int > &data_i)
	Construct a writer that writes to the specified scalar and integer vectors. More...

	~writer ()
	Destroy this writer. More...

std::vector< T > &	data_r ()
	Return a reference to the underlying vector of real values that have been written. More...

std::vector< int > &	data_i ()
	Return a reference to the underlying vector of integer values that have been written. More...

void	integer (int n)
	Write the specified integer to the sequence of integer values. More...

void	scalar_unconstrain (T &y)
	Write the unconstrained value corresponding to the specified scalar. More...

void	scalar_pos_unconstrain (T &y)
	Write the unconstrained value corresponding to the specified positive-constrained scalar. More...

void	scalar_lb_unconstrain (double lb, T &y)
	Return the unconstrained version of the specified input, which is constrained to be above the specified lower bound. More...

void	scalar_ub_unconstrain (double ub, T &y)
	Write the unconstrained value corresponding to the specified lower-bounded value. More...

void	scalar_lub_unconstrain (double lb, double ub, T &y)
	Write the unconstrained value corresponding to the specified value with the specified bounds. More...

void	corr_unconstrain (T &y)
	Write the unconstrained value corresponding to the specified correlation-constrained variable. More...

void	prob_unconstrain (T &y)
	Write the unconstrained value corresponding to the specified probability value. More...

void	ordered_unconstrain (vector_t &y)
	Write the unconstrained vector that corresponds to the specified ascendingly ordered vector. More...

void	positive_ordered_unconstrain (vector_t &y)
	Write the unconstrained vector that corresponds to the specified postiive ascendingly ordered vector. More...

void	vector_unconstrain (const vector_t &y)
	Write the specified unconstrained vector. More...

void	row_vector_unconstrain (const vector_t &y)
	Write the specified unconstrained vector. More...

void	matrix_unconstrain (const matrix_t &y)
	Write the specified unconstrained matrix. More...

void	vector_lb_unconstrain (double lb, vector_t &y)

void	row_vector_lb_unconstrain (double lb, row_vector_t &y)

void	matrix_lb_unconstrain (double lb, matrix_t &y)

void	vector_ub_unconstrain (double ub, vector_t &y)

void	row_vector_ub_unconstrain (double ub, row_vector_t &y)

void	matrix_ub_unconstrain (double ub, matrix_t &y)

void	vector_lub_unconstrain (double lb, double ub, vector_t &y)

void	row_vector_lub_unconstrain (double lb, double ub, row_vector_t &y)

void	matrix_lub_unconstrain (double lb, double ub, matrix_t &y)

void	simplex_unconstrain (vector_t &y)
	Write the unconstrained vector corresponding to the specified simplex value. More...

void	corr_matrix_unconstrain (matrix_t &y)
	Writes the unconstrained correlation matrix corresponding to the specified constrained correlation matrix. More...

void	cov_matrix_unconstrain (matrix_t &y)
	Writes the unconstrained covariance matrix corresponding to the specified constrained correlation matrix. More...

Public Attributes
const double	CONSTRAINT_TOLERANCE
	This is the tolerance for checking arithmetic bounds in rank and in simplexes. More...

Detailed Description

template<typename T>
class stan::io::writer< T >

A stream-based writer for integer, scalar, vector, matrix and array data types, which transforms from constrained to a sequence of constrained variables.

This class converts constrained values to unconstrained values with mappings that invert those defined in stan::io::reader to convert unconstrained values to constrained values.

Template Parameters

T	Basic scalar type.

Definition at line 23 of file writer.hpp.

Member Typedef Documentation

◆ array_vec_t

template<typename T >

typedef Eigen::Array<T,Eigen::Dynamic,1> stan::io::writer< T >::array_vec_t

Definition at line 33 of file writer.hpp.

◆ matrix_t

template<typename T >

typedef Eigen::Matrix<T,Eigen::Dynamic,Eigen::Dynamic> stan::io::writer< T >::matrix_t

Definition at line 29 of file writer.hpp.

◆ row_vector_t

template<typename T >

typedef Eigen::Matrix<T,1,Eigen::Dynamic> stan::io::writer< T >::row_vector_t

Definition at line 31 of file writer.hpp.

◆ vector_t

template<typename T >

typedef Eigen::Matrix<T,Eigen::Dynamic,1> stan::io::writer< T >::vector_t

Definition at line 30 of file writer.hpp.

Constructor & Destructor Documentation

◆ writer()

template<typename T >

stan::io::writer< T >::writer	(	std::vector< T > &	data_r,
		std::vector< int > &	data_i
	)

inline

Construct a writer that writes to the specified scalar and integer vectors.

Parameters

data_r	Scalar values.
data_i	Integer values.

Definition at line 48 of file writer.hpp.

◆ ~writer()

template<typename T >

stan::io::writer< T >::~writer ( )

inline

Destroy this writer.

Definition at line 58 of file writer.hpp.

Member Function Documentation

◆ corr_matrix_unconstrain()

template<typename T >

void stan::io::writer< T >::corr_matrix_unconstrain ( matrix_t & y )

inline

Writes the unconstrained correlation matrix corresponding to the specified constrained correlation matrix.

The unconstraining operation is the inverse of the constraining operation in corr_matrix_constrain(Matrix<T,Dynamic,Dynamic).

Parameters

y	Constrained correlation matrix.

Exceptions

std::runtime_error	if the correlation matrix has no elements or is not a square matrix.
std::runtime_error	if the correlation matrix cannot be factorized by factor_cov_matrix() or if the sds returned by factor_cov_matrix() on log scale are unconstrained.

Definition at line 366 of file writer.hpp.

◆ corr_unconstrain()

template<typename T >

void stan::io::writer< T >::corr_unconstrain ( T & y )

inline

Write the unconstrained value corresponding to the specified correlation-constrained variable.

The unconstraining transform is atanh(y), which reverses the transfrom in corr_constrain().

Parameters

y	Correlation value.

Exceptions

std::runtime_error if y is not between -1.0 and 1.0

Definition at line 179 of file writer.hpp.

◆ cov_matrix_unconstrain()

template<typename T >

void stan::io::writer< T >::cov_matrix_unconstrain ( matrix_t & y )

inline

Writes the unconstrained covariance matrix corresponding to the specified constrained correlation matrix.

The unconstraining operation is the inverse of the constraining operation in cov_matrix_constrain(Matrix<T,Dynamic,Dynamic).

Parameters

y	Constrained covariance matrix.

Exceptions

std::runtime_error if y has no elements or if it is not square

Definition at line 395 of file writer.hpp.

◆ data_i()

template<typename T >

std::vector<int>& stan::io::writer< T >::data_i ( )

inline

Return a reference to the underlying vector of integer values that have been written.

Returns: Values that have been written.

Definition at line 77 of file writer.hpp.

◆ data_r()

template<typename T >

std::vector<T>& stan::io::writer< T >::data_r ( )

inline

Return a reference to the underlying vector of real values that have been written.

Returns: Values that have been written.

Definition at line 66 of file writer.hpp.

◆ integer()

template<typename T >

void stan::io::writer< T >::integer ( int n )

inline

Write the specified integer to the sequence of integer values.

Parameters

n	Integer to write.

Definition at line 86 of file writer.hpp.

◆ matrix_lb_unconstrain()

template<typename T >

void stan::io::writer< T >::matrix_lb_unconstrain	(	double	lb,
		matrix_t &	y
	)

inline

Definition at line 290 of file writer.hpp.

◆ matrix_lub_unconstrain()

template<typename T >

void stan::io::writer< T >::matrix_lub_unconstrain	(	double	lb,
		double	ub,
		matrix_t &	y
	)

inline

Definition at line 319 of file writer.hpp.

◆ matrix_ub_unconstrain()

template<typename T >

void stan::io::writer< T >::matrix_ub_unconstrain	(	double	ub,
		matrix_t &	y
	)

inline

Definition at line 304 of file writer.hpp.

◆ matrix_unconstrain()

template<typename T >

void stan::io::writer< T >::matrix_unconstrain ( const matrix_t & y )

inline

Write the specified unconstrained matrix.

Parameters

y	Matrix to write.

Definition at line 276 of file writer.hpp.

◆ ordered_unconstrain()

template<typename T >

void stan::io::writer< T >::ordered_unconstrain ( vector_t & y )

inline

Write the unconstrained vector that corresponds to the specified ascendingly ordered vector.

The unconstraining transform is defined for input vector y to produce an output vector x of the same size, defined by x[0] = log(y[0]) and by x[k] = log(y[k] - y[k-1]) for k > 0. This unconstraining transform inverts the constraining transform specified in ordered_constrain(size_t).

Parameters

y	Ascendingly ordered vector.

Returns: Unconstrained vector corresponding to the specified vector.

Exceptions

std::runtime_error if vector is not in ascending order.

Definition at line 217 of file writer.hpp.

◆ positive_ordered_unconstrain()

template<typename T >

void stan::io::writer< T >::positive_ordered_unconstrain ( vector_t & y )

inline

Write the unconstrained vector that corresponds to the specified postiive ascendingly ordered vector.

The unconstraining transform is defined for input vector y to produce an output vector x of the same size, defined by x[0] = log(y[0]) and by x[k] = log(y[k] - y[k-1]) for k > 0. This unconstraining transform inverts the constraining transform specified in positive_ordered_constrain(size_t).

Parameters

y	Positive ascendingly ordered vector.

Returns: Unconstrained vector corresponding to the specified vector.

Exceptions

std::runtime_error if vector is not in ascending order.

Definition at line 241 of file writer.hpp.

◆ prob_unconstrain()

template<typename T >

void stan::io::writer< T >::prob_unconstrain ( T & y )

inline

Write the unconstrained value corresponding to the specified probability value.

The unconstraining transform is logit(y), which inverts the constraining transform defined in prob_constrain().

Parameters

y	Probability value.

Exceptions

std::runtime_error if y is not between 0.0 and 1.0

Definition at line 196 of file writer.hpp.

◆ row_vector_lb_unconstrain()

template<typename T >

void stan::io::writer< T >::row_vector_lb_unconstrain	(	double	lb,
		row_vector_t &	y
	)

inline

Definition at line 286 of file writer.hpp.

◆ row_vector_lub_unconstrain()

template<typename T >

void stan::io::writer< T >::row_vector_lub_unconstrain	(	double	lb,
		double	ub,
		row_vector_t &	y
	)

inline

Definition at line 315 of file writer.hpp.

◆ row_vector_ub_unconstrain()

template<typename T >

void stan::io::writer< T >::row_vector_ub_unconstrain	(	double	ub,
		row_vector_t &	y
	)

inline

Definition at line 300 of file writer.hpp.

◆ row_vector_unconstrain()

template<typename T >

void stan::io::writer< T >::row_vector_unconstrain ( const vector_t & y )

inline

Write the specified unconstrained vector.

Parameters

y	Vector to write.

Definition at line 266 of file writer.hpp.

◆ scalar_lb_unconstrain()

template<typename T >

void stan::io::writer< T >::scalar_lb_unconstrain	(	double	lb,
		T &	y
	)

inline

Return the unconstrained version of the specified input, which is constrained to be above the specified lower bound.

The unconstraining transform is log(y - lb), which inverts the constraining transform defined in reader::scalar_lb_constrain(double),

Parameters

lb	Lower bound.
y	Lower-bounded value.

Exceptions

std::runtime_error if y is lower than the lower bound provided.

Definition at line 129 of file writer.hpp.

◆ scalar_lub_unconstrain()

template<typename T >

void stan::io::writer< T >::scalar_lub_unconstrain	(	double	lb,
		double	ub,
		T &	y
	)

inline

Write the unconstrained value corresponding to the specified value with the specified bounds.

The unconstraining transform is given by reader::logit((y-L)/(U-L)), which inverts the constraining transform defined in scalar_lub_constrain(double,double).

Parameters

lb	Lower bound.
ub	Upper bound.
y	Bounded value.

Exceptions

std::runtime_error if y is not between the lower and upper bounds

Definition at line 163 of file writer.hpp.

◆ scalar_pos_unconstrain()

template<typename T >

void stan::io::writer< T >::scalar_pos_unconstrain ( T & y )

inline

Write the unconstrained value corresponding to the specified positive-constrained scalar.

The transformation applied is log(y), which is the inverse of constraining transform specified in reader::scalar_pos_constrain().

This method will fail if the argument is not non-negative.

Parameters

y	The positive value.

Exceptions

std::runtime_error if y is negative.

Definition at line 112 of file writer.hpp.

◆ scalar_ub_unconstrain()

template<typename T >

void stan::io::writer< T >::scalar_ub_unconstrain	(	double	ub,
		T &	y
	)

inline

Write the unconstrained value corresponding to the specified lower-bounded value.

The unconstraining transform is log(ub - y), which reverses the constraining transform defined in reader::scalar_ub_constrain(double).

Parameters

ub	Upper bound.
y	Constrained value.

Exceptions

std::runtime_error if y is higher than the upper bound provided.

Definition at line 145 of file writer.hpp.

◆ scalar_unconstrain()

template<typename T >

void stan::io::writer< T >::scalar_unconstrain ( T & y )

inline

Write the unconstrained value corresponding to the specified scalar.

Here, the unconstrain operation is a no-op, which matches reader::scalar_constrain().

Parameters

y	The value.

Definition at line 97 of file writer.hpp.

◆ simplex_unconstrain()

template<typename T >

void stan::io::writer< T >::simplex_unconstrain ( vector_t & y )

inline

Write the unconstrained vector corresponding to the specified simplex value.

If the specified constrained simplex is of size K, the returned unconstrained vector is of size K-1.

The transform takes y = y[1],...,y[K] and produces the unconstrained vector x = log(y[1]) - log(y[K]), ..., log(y[K-1]) - log(y[K]). This inverts the constraining transform of simplex_constrain(size_t).

Parameters

y	Simplex constrained value.

Returns: Unconstrained value.

Exceptions

std::runtime_error if the vector is not a simplex.

Definition at line 342 of file writer.hpp.

◆ vector_lb_unconstrain()

template<typename T >

void stan::io::writer< T >::vector_lb_unconstrain	(	double	lb,
		vector_t &	y
	)

inline

Definition at line 282 of file writer.hpp.

◆ vector_lub_unconstrain()

template<typename T >

void stan::io::writer< T >::vector_lub_unconstrain	(	double	lb,
		double	ub,
		vector_t &	y
	)

inline

Definition at line 311 of file writer.hpp.

◆ vector_ub_unconstrain()

template<typename T >

void stan::io::writer< T >::vector_ub_unconstrain	(	double	ub,
		vector_t &	y
	)

inline

Definition at line 296 of file writer.hpp.

◆ vector_unconstrain()

template<typename T >

void stan::io::writer< T >::vector_unconstrain ( const vector_t & y )

inline

Write the specified unconstrained vector.

Parameters

y	Vector to write.

Definition at line 256 of file writer.hpp.

Member Data Documentation

◆ CONSTRAINT_TOLERANCE

template<typename T >

const double stan::io::writer< T >::CONSTRAINT_TOLERANCE

This is the tolerance for checking arithmetic bounds in rank and in simplexes.

The current value is 1E-8.

Definition at line 39 of file writer.hpp.

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

src/stan/io/writer.hpp

Public Types

Public Member Functions

Public Attributes

Detailed Description

template<typename T> class stan::io::writer< T >

Member Typedef Documentation

◆ array_vec_t

◆ matrix_t

◆ row_vector_t

◆ vector_t

Constructor & Destructor Documentation

◆ writer()

◆ ~writer()

Member Function Documentation

◆ corr_matrix_unconstrain()

◆ corr_unconstrain()

◆ cov_matrix_unconstrain()

◆ data_i()

◆ data_r()

◆ integer()

◆ matrix_lb_unconstrain()

◆ matrix_lub_unconstrain()

◆ matrix_ub_unconstrain()

◆ matrix_unconstrain()

◆ ordered_unconstrain()

◆ positive_ordered_unconstrain()

◆ prob_unconstrain()

◆ row_vector_lb_unconstrain()

◆ row_vector_lub_unconstrain()

◆ row_vector_ub_unconstrain()

◆ row_vector_unconstrain()

◆ scalar_lb_unconstrain()

◆ scalar_lub_unconstrain()

◆ scalar_pos_unconstrain()

◆ scalar_ub_unconstrain()

◆ scalar_unconstrain()

◆ simplex_unconstrain()

◆ vector_lb_unconstrain()

◆ vector_lub_unconstrain()

◆ vector_ub_unconstrain()

◆ vector_unconstrain()

Member Data Documentation

◆ CONSTRAINT_TOLERANCE

template<typename T>
class stan::io::writer< T >