From a6db91118b5a74363ba82c8f81d285275d4833f3 Mon Sep 17 00:00:00 2001 From: David Wells Date: Sat, 25 Apr 2015 13:13:31 -0400 Subject: [PATCH] Update the estimated memory consumption comment. This one had a sentence fragment and mentioned the STL. --- include/deal.II/base/data_out_base.h | 88 ++++++++-------------- include/deal.II/base/function.h | 16 ++-- include/deal.II/base/function_derivative.h | 8 +- include/deal.II/base/function_lib.h | 8 +- include/deal.II/base/logstream.h | 8 +- include/deal.II/base/multithread_info.h | 8 +- 6 files changed, 51 insertions(+), 85 deletions(-) diff --git a/include/deal.II/base/data_out_base.h b/include/deal.II/base/data_out_base.h index 661a927d98..5cf8e18bcb 100644 --- a/include/deal.II/base/data_out_base.h +++ b/include/deal.II/base/data_out_base.h @@ -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 - * std::map 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., std::map) 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 - * std::map 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., std::map) 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 - * std::map 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., std::map) 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 - * std::map 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., std::map) 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 - * std::map 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., std::map) 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 - * std::map 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., std::map) 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 - * std::map 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., std::map) 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 - * std::map 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., std::map) 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 - * std::map 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., std::map) 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 - * std::map 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., std::map) 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 std::map - * 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., std::map) is difficult. */ std::size_t memory_consumption () const; diff --git a/include/deal.II/base/function.h b/include/deal.II/base/function.h index 04e37d5302..76d320d1fc 100644 --- a/include/deal.II/base/function.h +++ b/include/deal.II/base/function.h @@ -310,11 +310,9 @@ public: std::vector > &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 std::map - * 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., std::map) is difficult. */ std::size_t memory_consumption () const; }; @@ -500,11 +498,9 @@ public: std::vector > &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 std::map - * 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., std::map) is difficult. */ std::size_t memory_consumption () const; diff --git a/include/deal.II/base/function_derivative.h b/include/deal.II/base/function_derivative.h index 1094db84bf..3b831d720c 100644 --- a/include/deal.II/base/function_derivative.h +++ b/include/deal.II/base/function_derivative.h @@ -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 std::map - * 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., std::map) is difficult. */ std::size_t memory_consumption () const; diff --git a/include/deal.II/base/function_lib.h b/include/deal.II/base/function_lib.h index 4b77435317..62122dc30a 100644 --- a/include/deal.II/base/function_lib.h +++ b/include/deal.II/base/function_lib.h @@ -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 - * std::map 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., std::map) is difficult. */ std::size_t memory_consumption () const; diff --git a/include/deal.II/base/logstream.h b/include/deal.II/base/logstream.h index 9702fe0425..0845ba74e4 100644 --- a/include/deal.II/base/logstream.h +++ b/include/deal.II/base/logstream.h @@ -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 std::map - * 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., std::map) is difficult. */ std::size_t memory_consumption () const; diff --git a/include/deal.II/base/multithread_info.h b/include/deal.II/base/multithread_info.h index a28c179612..c8b5a47916 100644 --- a/include/deal.II/base/multithread_info.h +++ b/include/deal.II/base/multithread_info.h @@ -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 std::map - * 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., std::map) is difficult. */ static std::size_t memory_consumption (); -- 2.39.5