Cleanup of BBP code
[libdai.git] / include / dai / regiongraph.h
index 051d7b9..8100120 100644 (file)
@@ -1,6 +1,7 @@
-/*  Copyright (C) 2006-2008  Joris Mooij  [j dot mooij at science dot ru dot nl]
-    Radboud University Nijmegen, The Netherlands
-    
+/*  Copyright (C) 2006-2008  Joris Mooij  [joris dot mooij at tuebingen dot mpg dot de]
+    Radboud University Nijmegen, The Netherlands /
+    Max Planck Institute for Biological Cybernetics, Germany
+
     This file is part of libDAI.
 
     libDAI is free software; you can redistribute it and/or modify
 */
 
 
+/// \file
+/// \brief Defines classes Region, FRegion and RegionGraph
+/// \todo Improve documentation
+
+
 #ifndef __defined_libdai_regiongraph_h
 #define __defined_libdai_regiongraph_h
 
@@ -34,7 +40,7 @@ namespace dai {
 
 /// A Region is a set of variables with a counting number
 class Region : public VarSet {
-    protected:
+    private:
         /// Counting number
         double          _c;
 
@@ -45,18 +51,6 @@ class Region : public VarSet {
         /// Construct Region from a VarSet and a counting number
         Region(const VarSet & x, double c) : VarSet(x), _c(c) {}
         
-        /// Copy constructor
-        Region(const Region & x) : VarSet(x), _c(x._c) {}
-
-        /// Assignment operator
-        Region & operator=(const Region & x) {
-            if( this != &x ) {
-                VarSet::operator=(x);
-                _c          = x._c;
-            }
-            return *this;
-        }
-
         /// Provide read access to counting number
         const double & c() const { return _c; }
         /// Provide full access to counting number
@@ -66,7 +60,7 @@ class Region : public VarSet {
 
 /// A FRegion is a factor with a counting number
 class FRegion : public Factor {
-    protected:
+    private:
         /// Counting number
         double _c;
 
@@ -77,18 +71,6 @@ class FRegion : public Factor {
         /// Constructs FRegion from a Factor and a counting number
         FRegion( const Factor & x, double c ) : Factor(x), _c(c) {}
         
-        /// Copy constructor
-        FRegion( const FRegion & x ) : Factor(x), _c(x._c) {}
-
-        /// Assignment operator
-        FRegion & operator=(const FRegion & x) {
-            if( this != &x ) {
-                Factor::operator=(x);
-                _c = x._c;
-            }
-            return *this;
-        }
-
         /// Provide read access to counting number
         const double & c() const { return _c; }
         /// Provide full access to counting number
@@ -99,12 +81,16 @@ class FRegion : public Factor {
 /// A RegionGraph is a bipartite graph consisting of outer regions (type FRegion) and inner regions (type Region)
 class RegionGraph : public FactorGraph {
     public:
+        /// Stores the neighborhood structure
         BipartiteGraph          G;
+
+        /// The outer regions (corresponding to nodes of type 1)
         std::vector<FRegion>    ORs;
+
+        /// The inner regions (corresponding to nodes of type 2)
         std::vector<Region>     IRs;
 
-    protected:
-        /// Give back the OR index that corresponds to a factor index
+        /// Stores for each factor index the index of the outer region it belongs to
         std::vector<size_t>     fac2OR;
 
 
@@ -121,27 +107,12 @@ class RegionGraph : public FactorGraph {
         /// Constructs a RegionGraph from a FactorGraph and a vector of outer VarSets (CVM style)
         RegionGraph( const FactorGraph &fg, const std::vector<VarSet> &cl );
 
-        /// Copy constructor
-        RegionGraph( const RegionGraph &x ) : FactorGraph(x), G(x.G), ORs(x.ORs), IRs(x.IRs), fac2OR(x.fac2OR) {}
-
-        /// Assignment operator
-        RegionGraph & operator=( const RegionGraph &x ) {
-            if( this != &x ) {
-                FactorGraph::operator=( x );
-                G = x.G;
-                ORs = x.ORs;
-                IRs = x.IRs;
-                fac2OR = x.fac2OR;
-            }
-            return *this;
-        }
+        /// Clone *this (virtual copy constructor)
+        virtual RegionGraph* clone() const { return new RegionGraph(*this); }
 
         /// Create (virtual default constructor)
         virtual RegionGraph* create() const { return new RegionGraph(); }
 
-        /// Clone (virtual copy constructor)
-        virtual RegionGraph* clone() const { return new RegionGraph(*this); }
-
         /// Set the content of the I'th factor and make a backup of its old content if backup == true
         virtual void setFactor( size_t I, const Factor &newFactor, bool backup = false ) {
             FactorGraph::setFactor( I, newFactor, backup ); 
@@ -199,7 +170,7 @@ class RegionGraph : public FactorGraph {
         /// Recompute all outer regions involving factor I
         void RecomputeOR( size_t I );
 
-        /// Send RegionGraph to output stream
+        // Friends
         friend std::ostream & operator << ( std::ostream & os, const RegionGraph & rg );
 };