Fixed tabs and trailing whitespaces

[libdai.git] / include / dai / var.h

diff --git a/include/dai/var.h b/include/dai/var.h
index e9deda1..481c6bf 100644 (file)
--- a/include/dai/var.h
+++ b/include/dai/var.h
@@ -1,7 +1,10 @@
-/*  Copyright (C) 2006-2008  Joris Mooij  [j dot mooij at science dot ru dot nl]
+/*  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
+
     Copyright (C) 2002  Martijn Leisink  [martijn@mbfys.kun.nl]
     Radboud University Nijmegen, The Netherlands
-    
+
     This file is part of libDAI.
 
     libDAI is free software; you can redistribute it and/or modify
@@ -20,61 +23,97 @@
 */
 
 
+/// \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:
-        /// Internal label of the variable
+        /// Label of the variable (its unique ID)
         long    _label;
 
         /// Number of possible values
         size_t  _states;
-        
+
     public:
         /// Default constructor
         Var() : _label(-1), _states(0) {}
         /// Constructor
         Var( long label, size_t states ) : _label(label), _states(states) {}
 
-        /// Gets the label
+        /// Returns the label
         long label() const { return _label; }
         /// Returns reference to label
         long & label() { return _label; }
 
-        /// Gets the number of states
+        /// Returns the number of states
         size_t states () const { return _states; }
         /// Returns reference to number of states
         size_t& states () { return _states; }
 
-        /// Smaller-than operator (compares labels)
+        /// Smaller-than operator (compares only labels)
         bool operator < ( const Var& n ) const { return( _label <  n._label ); }
-        /// Larger-than operator (compares labels)
+        /// Larger-than operator (compares only labels)
         bool operator > ( const Var& n ) const { return( _label >  n._label ); }
-        /// Smaller-than-or-equal-to operator (compares labels)
-        bool operator <= ( const Var& n ) const { return( _label <= n._label ); }
-        /// Larger-than-or-equal-to operator (compares labels)
-        bool operator >= ( const Var& n ) const { return( _label >= n._label ); }
-        /// Not-equal-to operator (compares labels)
-        bool operator != ( const Var& n ) const { return( _label != n._label ); }
-        /// Equal-to operator (compares labels)
-        bool operator == ( const Var& n ) const { return( _label == n._label ); }
-
-        /// Write this Var to stream
+        /// Smaller-than-or-equal-to operator (only compares labels)
+        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 {
+#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 {
+#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 {
+#ifdef DAI_DEBUG
+            if( _label == n._label )
+                assert( _states == n._states );
+#endif
+            return( _label == n._label );
+        }
+
+        /// 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() );
         }
 };