Stan  2.14.0
probability, sampling & optimization
Public Types | Public Member Functions | Public Attributes | List of all members
stan::lang::printable Struct Reference

A printable object is either an expression or a string. More...

#include <printable.hpp>

Public Types

typedef boost::variant< boost::recursive_wrapper< std::string >, boost::recursive_wrapper< expression > > printable_t
 Variant type for member variable to store. More...
 

Public Member Functions

 printable ()
 Construct a printable object with an empty string. More...
 
 printable (const expression &expr)
 Construct a printable object with the specified expression. More...
 
 printable (const std::string &msg)
 Construct a printable object with the specified string. More...
 
 printable (const printable_t &printable)
 Construct a printable object with an object of its variant type. More...
 
 printable (const printable &printable)
 Copy constructor to construct printable from a printable. More...
 

Public Attributes

printable_t printable_
 The stored printable object. More...
 

Detailed Description

A printable object is either an expression or a string.

Definition at line 17 of file printable.hpp.

Member Typedef Documentation

§ printable_t

typedef boost::variant<boost::recursive_wrapper<std::string>, boost::recursive_wrapper<expression> > stan::lang::printable::printable_t

Variant type for member variable to store.

Definition at line 23 of file printable.hpp.

Constructor & Destructor Documentation

§ printable() [1/5]

stan::lang::printable::printable ( )

Construct a printable object with an empty string.

Definition at line 10 of file printable_def.hpp.

§ printable() [2/5]

stan::lang::printable::printable ( const expression expr)

Construct a printable object with the specified expression.

Parameters
exprexpression to store

Definition at line 12 of file printable_def.hpp.

§ printable() [3/5]

stan::lang::printable::printable ( const std::string &  msg)

Construct a printable object with the specified string.

Parameters
msgmessage to store

Definition at line 14 of file printable_def.hpp.

§ printable() [4/5]

stan::lang::printable::printable ( const printable_t printable)

Construct a printable object with an object of its variant type.

Parameters
printablevariant string or expression

Definition at line 16 of file printable_def.hpp.

§ printable() [5/5]

stan::lang::printable::printable ( const printable printable)

Copy constructor to construct printable from a printable.

Parameters
printableprintable to copy

Definition at line 19 of file printable_def.hpp.

Member Data Documentation

§ printable_

printable_t stan::lang::printable::printable_

The stored printable object.

Definition at line 62 of file printable.hpp.


The documentation for this struct was generated from the following files:

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