/usr/include/JAGS/sampler/Sampler.h is in jags 4.1.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 | #ifndef SAMPLER_H_
#define SAMPLER_H_
#include <vector>
#include <string>
#include <set>
namespace jags {
struct RNG;
class StochasticNode;
class GraphView;
/**
* @short Updates a set of stochastic nodes
*
* A sampler updates a set of stochastic nodes at each iteration.
* In addition, the sampler is responsible for updating the immediate
* deterministic descendants of the sampled nodes.
*
* The Sampler class is designed to be as abstract as possible to give
* maximum freedom in implementing samplers. In practice, all the
* Samplers in the modules distributed with JAGS are implementations
* of one of two subclasses -- MutableSampler or ImmutableSampler --
* depending on whether the Sampler does or does not have a state that
* it must preserve between iterations.
*/
class Sampler {
GraphView *_gv;
public:
/**
* Constructor
*
* @param gv GraphView providing a view of the sampling graph for
* the sampler. This should be dynamically allocated by the
* SamplerFactory: the Sampler takes ownership of the GraphView
* and deletes it when the destructor is called.
*/
Sampler(GraphView *gv);
virtual ~Sampler();
/**
* Returns the vector of stochastic nodes sampled by the Sampler
*/
std::vector<StochasticNode*> const &nodes() const;
/**
* Every sampler must update the vector of nodes and its immediate
* deterministic descendants using the update function.
*
* @param rng vector of Pseudo-random number generator functions.
*/
virtual void update(std::vector<RNG *> const &rng) = 0;
/**
* When a sampler is constructed, it may be in adaptive mode, which
* allows it to adapt its behaviour for increased
* efficiency. However, a sampler in adaptive mode may not converge
* to the correct target distribution. This function turns off
* adaptive mode, so that valid samples can be collected from the
* sampler.
*/
virtual void adaptOff() = 0;
/**
* The adaptOff function may be called at any time. Premature
* ending of adaptive mode may result in an extremely inefficient
* sampler. Therefore the checkAdaptation function implements an
* efficiency test that returns true if it is safe to call the
* adaptOff function. Samplers that have no adaptive mode should
* simply return true.
*/
virtual bool checkAdaptation() const = 0;
/**
* Indicates whether the sampler has an adaptive mode.
*/
virtual bool isAdaptive() const = 0;
/**
* Returns a name for the sampler which should describe the method
* it uses to update the nodes.
*/
virtual std::string name() const = 0;
};
} /* namespace jags */
#endif /* SAMPLER_H_ */
|