Changeset 420

Timestamp:

07/20/09 10:11:50 (15 years ago)

Author:

vbarta

Message:

some inline documentation, using it_assert_debug (like other library classes)

Files:

• library/bdm/shared_ptr.h (modified) (5 diffs)

library/bdm/shared_ptr.h

@@ -14 +14 @@
 #define shared_ptr_h
 
-#include <assert.h>
 #include <limits.h>
 #include <algorithm>
 #include <stdexcept>
 #include <string>
+#include "itpp_ext.h"
 
 namespace bdm {
@@ -33 +33 @@
 
 public:
+    //! Creates an empty shared_ptr - one that doesn't point anywhere.
     shared_ptr():
         payload(0),
@@ -39 +40 @@
     }
 
+    //! Constructs a shared_ptr that owns the pointer p (unless p is
+    //! null, in which case this constructor creates an empty
+    //! shared_ptr).
     shared_ptr(T *p):
         payload(p),
@@ -45 +49 @@
     }
 
+    //! If other is empty, constructs an empty shared_ptr; otherwise,
+    //! constructs a shared_ptr that shares ownership with other.
     shared_ptr(const shared_ptr &other):
         payload(other.payload),
@@ -68 +74 @@
     }
 
+    //! Returns the stored pointer (which remains owned by this
+    //! instance).
     T *get() { return payload; }
 
+    //! Returns the stored pointer (which remains owned by this
+    //! instance). This method may only be called when the stored
+    //! pointer isn't NULL.
     T *operator->()
     {
-        assert(payload);
+        it_assert_debug(payload, "dereferencing NULL");
         return payload;
     }
 
+    //! Returns a reference to the object pointed to by the stored
+    //! pointer. This method may only be called when the stored pointer
+    //! isn't NULL.
     T &operator*()
     {
-        assert(payload);
+        it_assert_debug(payload, "dereferencing NULL");
         return *payload;
     }
 
+    //! Returns the stored pointer (which remains owned by this
+    //! instance).
     const T* get() const { return payload; }
 
+    //! Returns the stored pointer (which remains owned by this
+    //! instance). This method may only be called when the stored
+    //! pointer isn't NULL.
     const T *operator->() const
     {
-        assert(payload);
+        it_assert_debug(payload, "dereferencing NULL");
         return payload;
     }
 
+    //! Returns a reference to the object pointed to by the stored
+    //! pointer. This method may only be called when the stored pointer
+    //! isn't NULL.
     const T &operator*() const
     {
-        assert(payload);
+        it_assert_debug(payload, "dereferencing NULL");
         return *payload;
     }