]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update documentation of VectorMemory::Pointer. 3008/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Wed, 24 Aug 2016 12:24:16 +0000 (06:24 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Wed, 24 Aug 2016 12:24:16 +0000 (06:24 -0600)
include/deal.II/lac/vector_memory.h

index 88f084f9b9645c47459f1d69fa508e952ec2a02f..a63424cd3ddfd8dcec9bf1f3b34ae1859cebeb9e 100644 (file)
@@ -106,10 +106,17 @@ public:
 
   //@}
   /**
-   * Pointer to vectors allocated from VectorMemory objects. This pointer is
-   * safe in the sense that it automatically calls free() when it is
-   * destroyed, thus relieving the user from using vector management functions
-   * at all.
+   * A class that looks like a pointer for all practical purposes and that
+   * upon construction time allocates a vector from a VectorMemory object
+   * (or an object of a derived class) that is passed to the constructor.
+   * The destructor then automatically returns the vector's ownership to
+   * the same VectorMemory object.
+   *
+   * Pointers of this type are therefore safe in the sense that they automatically
+   * call VectorMemory::free() when they are destroyed, whether that happens
+   * at the end of a code block or because local variables are destroyed during
+   * exception unwinding. These kinds of object thus relieve the user from
+   * using vector management functions explicitly.
    *
    * @author Guido Kanschat, 2009
    */
@@ -139,11 +146,13 @@ public:
      * Dereferencing operator.
      */
     VectorType *operator -> () const;
+
   private:
     /**
      * The memory pool used.
      */
     SmartPointer<VectorMemory<VectorType>,Pointer> pool;
+
     /**
      * The pointer to the vector.
      */

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.