Fixed tabs and trailing whitespaces
[libdai.git] / include / dai / var.h
index 5deb3ff..481c6bf 100644 (file)
 */
 
 
+/// \file
+/// \brief Defines class Var
+
+
 #ifndef __defined_libdai_var_h
 #define __defined_libdai_var_h
 
 
 #include <iostream>
+#include <cassert>
 
 
 namespace dai {
 
 
-/// Represents a discrete variable.
-/**  It contains the label of the variable, an integer-valued
- *  unique ID for that variable, and the number of possible 
- *  values ("states") of the variable.
+/// Represents a discrete random variable.
+/** A Var stores the \a label of the variable (an integer-valued unique ID)
+ *  and the number of possible values (\a states) of that variable. Two
+ *  Var objects with the same label are assumed to be identical (i.e., it
+ *  is assumed that their states are also the same).
+ *
+ *  In this manual, we use the following notational conventions. The discrete
+ *  random variable with label \f$l\f$ is denoted as \f$x_l\f$, and the number
+ *  of possible values of this variable as \f$S_l\f$; this is represented in
+ *  code by the object Var(\f$l\f$,\f$S_l\f$). The set of possible values of
+ *  variable \f$x_l\f$ is denoted \f$X_l := \{0,1,\dots,S_l-1\}\f$.
  */
 class Var {
     private:
@@ -45,7 +57,7 @@ class Var {
 
         /// Number of possible values
         size_t  _states;
-        
+
     public:
         /// Default constructor
         Var() : _label(-1), _states(0) {}
@@ -62,22 +74,46 @@ class Var {
         /// Returns reference to number of states
         size_t& states () { return _states; }
 
-        /// Smaller-than operator (only compares labels)
+        /// Smaller-than operator (compares only labels)
         bool operator < ( const Var& n ) const { return( _label <  n._label ); }
-        /// Larger-than operator (only compares labels)
+        /// Larger-than operator (compares only labels)
         bool operator > ( const Var& n ) const { return( _label >  n._label ); }
         /// Smaller-than-or-equal-to operator (only compares labels)
-        bool operator <= ( const Var& n ) const { return( _label <= n._label ); }
+        bool operator <= ( const Var& n ) const {
+#ifdef DAI_DEBUG
+            if( _label == n._label )
+                assert( _states == n._states );
+#endif
+            return( _label <= n._label );
+        }
         /// Larger-than-or-equal-to operator (only compares labels)
-        bool operator >= ( const Var& n ) const { return( _label >= n._label ); }
+        bool operator >= ( const Var& n ) const {
+#ifdef DAI_DEBUG
+            if( _label == n._label )
+                assert( _states == n._states );
+#endif
+            return( _label >= n._label );
+        }
         /// Not-equal-to operator (only compares labels)
-        bool operator != ( const Var& n ) const { return( _label != n._label ); }
+        bool operator != ( const Var& n ) const {
+#ifdef DAI_DEBUG
+            if( _label == n._label )
+                assert( _states == n._states );
+#endif
+            return( _label != n._label );
+        }
         /// Equal-to operator (only compares labels)
-        bool operator == ( const Var& n ) const { return( _label == n._label ); }
+        bool operator == ( const Var& n ) const {
+#ifdef DAI_DEBUG
+            if( _label == n._label )
+                assert( _states == n._states );
+#endif
+            return( _label == n._label );
+        }
 
-        /// Write a Var to output stream
+        /// Writes a Var to an output stream
         friend std::ostream& operator << ( std::ostream& os, const Var& n ) {
-            return( os << "[" << n.label() << "]" );
+            return( os << "x" << n.label() );
         }
 };