]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update the estimated memory consumption comment.
authorDavid Wells <drwells@vt.edu>
Sat, 25 Apr 2015 17:13:31 +0000 (13:13 -0400)
committerDavid Wells <drwells@vt.edu>
Sun, 26 Apr 2015 16:46:56 +0000 (12:46 -0400)
This one had a sentence fragment and mentioned the STL.

include/deal.II/base/data_out_base.h
include/deal.II/base/function.h
include/deal.II/base/function_derivative.h
include/deal.II/base/function_lib.h
include/deal.II/base/logstream.h
include/deal.II/base/multithread_info.h

index 661a927d9856bf59dbd22bf731ce45d421968c93..5cf8e18bcbdfd10a34f277adabab7b67a7633ffb 100644 (file)
@@ -323,11 +323,9 @@ namespace DataOutBase
     bool operator == (const Patch &patch) const;
 
     /**
-     * Determine an estimate for the memory consumption (in bytes) of this
-     * object. Since sometimes the size of objects can not be determined
-     * exactly (for example: what is the memory consumption of an STL
-     * <tt>std::map</tt> type with a certain number of elements?), this is
-     * only an estimate. however often quite close to the true value.
+     * Return an estimate for the memory consumption, in bytes, of this
+     * object. This is not exact (but will usually be close) because calculating
+     * the memory usage of trees (e.g., <tt>std::map</tt>) is difficult.
      */
     std::size_t memory_consumption () const;
 
@@ -451,11 +449,9 @@ namespace DataOutBase
     void parse_parameters (const ParameterHandler &prm);
 
     /**
-     * Determine an estimate for the memory consumption (in bytes) of this
-     * object. Since sometimes the size of objects can not be determined
-     * exactly (for example: what is the memory consumption of an STL
-     * <tt>std::map</tt> type with a certain number of elements?), this is
-     * only an estimate. however often quite close to the true value.
+     * Return an estimate for the memory consumption, in bytes, of this
+     * object. This is not exact (but will usually be close) because calculating
+     * the memory usage of trees (e.g., <tt>std::map</tt>) is difficult.
      */
     std::size_t memory_consumption () const;
   };
@@ -497,11 +493,9 @@ namespace DataOutBase
     void parse_parameters (const ParameterHandler &prm) const;
 
     /**
-     * Determine an estimate for the memory consumption (in bytes) of this
-     * object. Since sometimes the size of objects can not be determined
-     * exactly (for example: what is the memory consumption of an STL
-     * <tt>std::map</tt> type with a certain number of elements?), this is
-     * only an estimate. however often quite close to the true value.
+     * Return an estimate for the memory consumption, in bytes, of this
+     * object. This is not exact (but will usually be close) because calculating
+     * the memory usage of trees (e.g., <tt>std::map</tt>) is difficult.
      */
     std::size_t memory_consumption () const;
   };
@@ -558,11 +552,9 @@ namespace DataOutBase
     void parse_parameters (const ParameterHandler &prm);
 
     /**
-     * Determine an estimate for the memory consumption (in bytes) of this
-     * object. Since sometimes the size of objects can not be determined
-     * exactly (for example: what is the memory consumption of an STL
-     * <tt>std::map</tt> type with a certain number of elements?), this is
-     * only an estimate. however often quite close to the true value.
+     * Return an estimate for the memory consumption, in bytes, of this
+     * object. This is not exact (but will usually be close) because calculating
+     * the memory usage of trees (e.g., <tt>std::map</tt>) is difficult.
      */
     std::size_t memory_consumption () const;
   };
@@ -805,11 +797,9 @@ namespace DataOutBase
     void parse_parameters (const ParameterHandler &prm);
 
     /**
-     * Determine an estimate for the memory consumption (in bytes) of this
-     * object. Since sometimes the size of objects can not be determined
-     * exactly (for example: what is the memory consumption of an STL
-     * <tt>std::map</tt> type with a certain number of elements?), this is
-     * only an estimate. however often quite close to the true value.
+     * Return an estimate for the memory consumption, in bytes, of this
+     * object. This is not exact (but will usually be close) because calculating
+     * the memory usage of trees (e.g., <tt>std::map</tt>) is difficult.
      */
     std::size_t memory_consumption () const;
   };
@@ -851,11 +841,9 @@ namespace DataOutBase
     void parse_parameters (const ParameterHandler &prm) const;
 
     /**
-     * Determine an estimate for the memory consumption (in bytes) of this
-     * object. Since sometimes the size of objects can not be determined
-     * exactly (for example: what is the memory consumption of an STL
-     * <tt>std::map</tt> type with a certain number of elements?), this is
-     * only an estimate. however often quite close to the true value.
+     * Return an estimate for the memory consumption, in bytes, of this
+     * object. This is not exact (but will usually be close) because calculating
+     * the memory usage of trees (e.g., <tt>std::map</tt>) is difficult.
      */
     std::size_t memory_consumption () const;
   };
@@ -904,11 +892,9 @@ namespace DataOutBase
     void parse_parameters (const ParameterHandler &prm) const;
 
     /**
-     * Determine an estimate for the memory consumption (in bytes) of this
-     * object. Since sometimes the size of objects can not be determined
-     * exactly (for example: what is the memory consumption of an STL
-     * <tt>std::map</tt> type with a certain number of elements?), this is
-     * only an estimate. however often quite close to the true value.
+     * Return an estimate for the memory consumption, in bytes, of this
+     * object. This is not exact (but will usually be close) because calculating
+     * the memory usage of trees (e.g., <tt>std::map</tt>) is difficult.
      */
     std::size_t memory_consumption () const;
   };
@@ -983,11 +969,9 @@ namespace DataOutBase
     void parse_parameters (const ParameterHandler &prm) const;
 
     /**
-     * Determine an estimate for the memory consumption (in bytes) of this
-     * object. Since sometimes the size of objects can not be determined
-     * exactly (for example: what is the memory consumption of an STL
-     * <tt>std::map</tt> type with a certain number of elements?), this is
-     * only an estimate. however often quite close to the true value.
+     * Return an estimate for the memory consumption, in bytes, of this
+     * object. This is not exact (but will usually be close) because calculating
+     * the memory usage of trees (e.g., <tt>std::map</tt>) is difficult.
      */
     std::size_t memory_consumption () const;
   };
@@ -1046,11 +1030,9 @@ namespace DataOutBase
              const bool draw_colorbar = true);
 
     /**
-     * Determine an estimate for the memory consumption (in bytes) of this
-     * object. Since sometimes the size of objects can not be determined
-     * exactly (for example: what is the memory consumption of an STL
-     * <tt>std::map</tt> type with a certain number of elements?), this is
-     * only an estimate. however often quite close to the true value.
+     * Return an estimate for the memory consumption, in bytes, of this
+     * object. This is not exact (but will usually be close) because calculating
+     * the memory usage of trees (e.g., <tt>std::map</tt>) is difficult.
      */
     std::size_t memory_consumption () const;
   };
@@ -1101,11 +1083,9 @@ namespace DataOutBase
     void parse_parameters (const ParameterHandler &prm) const;
 
     /**
-     * Determine an estimate for the memory consumption (in bytes) of this
-     * object. Since sometimes the size of objects can not be determined
-     * exactly (for example: what is the memory consumption of an STL
-     * <tt>std::map</tt> type with a certain number of elements?), this is
-     * only an estimate. however often quite close to the true value.
+     * Return an estimate for the memory consumption, in bytes, of this
+     * object. This is not exact (but will usually be close) because calculating
+     * the memory usage of trees (e.g., <tt>std::map</tt>) is difficult.
      */
     std::size_t memory_consumption () const;
   };
@@ -2505,11 +2485,9 @@ public:
   void parse_parameters (ParameterHandler &prm);
 
   /**
-   * Determine an estimate for the memory consumption (in bytes) of this
-   * object. Since sometimes the size of objects can not be determined exactly
-   * (for example: what is the memory consumption of an STL <tt>std::map</tt>
-   * type with a certain number of elements?), this is only an estimate.
-   * however often quite close to the true value.
+   * Return an estimate for the memory consumption, in bytes, of this
+   * object. This is not exact (but will usually be close) because calculating
+   * the memory usage of trees (e.g., <tt>std::map</tt>) is difficult.
    */
   std::size_t memory_consumption () const;
 
index 04e37d53027ee755bac4aca67616ecf8421fc6b1..76d320d1fc603b4def3664ad48b21e45cc8681ba 100644 (file)
@@ -310,11 +310,9 @@ public:
                                       std::vector<Vector<Number> >   &values) const;
 
   /**
-   * Determine an estimate for the memory consumption (in bytes) of this
-   * object. Since sometimes the size of objects can not be determined exactly
-   * (for example: what is the memory consumption of an STL <tt>std::map</tt>
-   * type with a certain number of elements?), this is only an estimate.
-   * however often quite close to the true value.
+   * Return an estimate for the memory consumption, in bytes, of this
+   * object. This is not exact (but will usually be close) because calculating
+   * the memory usage of trees (e.g., <tt>std::map</tt>) is difficult.
    */
   std::size_t memory_consumption () const;
 };
@@ -500,11 +498,9 @@ public:
                                   std::vector<Vector<Number> >   &values) const;
 
   /**
-   * Determine an estimate for the memory consumption (in bytes) of this
-   * object. Since sometimes the size of objects can not be determined exactly
-   * (for example: what is the memory consumption of an STL <tt>std::map</tt>
-   * type with a certain number of elements?), this is only an estimate.
-   * however often quite close to the true value.
+   * Return an estimate for the memory consumption, in bytes, of this
+   * object. This is not exact (but will usually be close) because calculating
+   * the memory usage of trees (e.g., <tt>std::map</tt>) is difficult.
    */
   std::size_t memory_consumption () const;
 
index 1094db84bf0da10f2c4e92bdb919dbe85a4566c4..3b831d720ce38745cee4007ee3f31eaf0c5cc606 100644 (file)
@@ -95,11 +95,9 @@ public:
                            const unsigned int              component = 0) const;
 
   /**
-   * Determine an estimate for the memory consumption (in bytes) of this
-   * object. Since sometimes the size of objects can not be determined exactly
-   * (for example: what is the memory consumption of an STL <tt>std::map</tt>
-   * type with a certain number of elements?), this is only an estimate.
-   * however often quite close to the true value.
+   * Return an estimate for the memory consumption, in bytes, of this
+   * object. This is not exact (but will usually be close) because calculating
+   * the memory usage of trees (e.g., <tt>std::map</tt>) is difficult.
    */
   std::size_t memory_consumption () const;
 
index 4b774353179d536ab5dcad33d0fffb4c07a9e037..62122dc30a356cbc297038056458fc45096c1b75 100644 (file)
@@ -578,11 +578,9 @@ namespace Functions
                                  const unsigned int              component = 0) const;
 
     /**
-     * Determine an estimate for the memory consumption (in bytes) of this
-     * object. Since sometimes the size of objects can not be determined
-     * exactly (for example: what is the memory consumption of an STL
-     * <tt>std::map</tt> type with a certain number of elements?), this is
-     * only an estimate. however often quite close to the true value.
+     * Return an estimate for the memory consumption, in bytes, of this
+     * object. This is not exact (but will usually be close) because calculating
+     * the memory usage of trees (e.g., <tt>std::map</tt>) is difficult.
      */
     std::size_t memory_consumption () const;
 
index 9702fe042539c434d74b3f74673e4e3c9e52ab6e..0845ba74e405924cd3dc7763da340a322fbd00cc 100644 (file)
@@ -390,11 +390,9 @@ public:
 
 
   /**
-   * Determine an estimate for the memory consumption (in bytes) of this
-   * object. Since sometimes the size of objects can not be determined exactly
-   * (for example: what is the memory consumption of an STL <tt>std::map</tt>
-   * type with a certain number of elements?), this is only an estimate.
-   * however often quite close to the true value.
+   * Return an estimate for the memory consumption, in bytes, of this
+   * object. This is not exact (but will usually be close) because calculating
+   * the memory usage of trees (e.g., <tt>std::map</tt>) is difficult.
    */
   std::size_t memory_consumption () const;
 
index a28c179612af4a7613371cf37669a83d9fc254e9..c8b5a4791643858ad17497c863ed933ba8b7d601 100644 (file)
@@ -71,11 +71,9 @@ public:
   static unsigned int n_threads ();
 
   /**
-   * Determine an estimate for the memory consumption (in bytes) of this
-   * object. Since sometimes the size of objects can not be determined exactly
-   * (for example: what is the memory consumption of an STL <tt>std::map</tt>
-   * type with a certain number of elements?), this is only an estimate.
-   * however often quite close to the true value.
+   * Return an estimate for the memory consumption, in bytes, of this
+   * object. This is not exact (but will usually be close) because calculating
+   * the memory usage of trees (e.g., <tt>std::map</tt>) is difficult.
    */
   static std::size_t memory_consumption ();
 

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.