1 /* This file is part of libDAI - http://www.libdai.org/
3 * libDAI is licensed under the terms of the GNU General Public License version
4 * 2, or (at your option) any later version. libDAI is distributed without any
5 * warranty. See the file COPYING for more details.
7 * Copyright (C) 2009 Charles Vaske [cvaske at soe dot ucsc dot edu]
8 * Copyright (C) 2009 University of California, Santa Cruz
13 /// \brief Defines classes Evidence and Observation
14 /// \todo Describe tabular data file format
15 /// \todo Improve documentation
18 #ifndef __defined_libdai_evidence_h
19 #define __defined_libdai_evidence_h
23 #include <dai/daialg.h>
29 /// Stores observed values of a subset of variables
32 /// Used to store the state of some variables
33 std::map
<Var
, size_t> _obs
;
36 /// Default constructor
37 Observation() : _obs() {}
39 /// Get all observations
40 const std::map
<Var
, size_t>& observations() const { return _obs
; }
42 /// Add an observation
43 void addObservation( Var node
, size_t setting
);
45 /// Clamp variables in the graphical model to their observed values
46 void applyEvidence( InfAlg
& alg
) const;
50 /// Stores multiple joint observations of sets of variables.
51 /** The Evidence class stores multiple samples, where each sample is the joint
52 * observation of the states of some variables.
56 /// Each sample is the joint observation of the states of some variables
57 std::vector
<Observation
> _samples
;
60 /// Default constructor
61 Evidence() : _samples() {}
63 /// Construct from existing samples
64 Evidence( std::vector
<Observation
> &samples
) : _samples(samples
) {}
66 /// Read in tabular data from a stream.
67 /** Each line contains one sample, and the first line is a header line with names.
69 void addEvidenceTabFile( std::istream
& is
, std::map
<std::string
, Var
> &varMap
);
71 /// Read in tabular data from a stream.
72 /** Each line contains one sample, and the first line is a header line with
73 * variable labels which should correspond with a subset of the variables in fg.
75 void addEvidenceTabFile( std::istream
& is
, FactorGraph
& fg
);
77 /// Returns number of stored samples
78 size_t nrSamples() const { return _samples
.size(); }
80 /// @name Iterator interface
82 /// Iterator over the elements
83 typedef std::vector
<Observation
>::iterator iterator
;
84 /// Constant iterator over the elements
85 typedef std::vector
<Observation
>::const_iterator const_iterator
;
87 /// Returns iterator that points to the first element
88 iterator
begin() { return _samples
.begin(); }
89 /// Returns constant iterator that points to the first element
90 const_iterator
begin() const { return _samples
.begin(); }
91 /// Returns iterator that points beyond the last element
92 iterator
end() { return _samples
.end(); }
93 /// Returns constant iterator that points beyond the last element
94 const_iterator
end() const { return _samples
.end(); }
99 } // end of namespace dai