]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Improve docu
authorMaximilian Bergbauer <bergbauer@lnm.mw.tum.de>
Wed, 24 May 2023 20:13:08 +0000 (22:13 +0200)
committerMaximilian Bergbauer <bergbauer@lnm.mw.tum.de>
Wed, 24 May 2023 20:13:08 +0000 (22:13 +0200)
include/deal.II/base/vectorization.h

index cce9b00d82101ee94fea24d6b882fa39e477744a..2100c84335f77a6e281949986810d1423407c98d 100644 (file)
@@ -657,7 +657,8 @@ public:
   }
 
   /**
-   * Returns sum over entries of data field.
+   * Returns sum over entries of the data field, $\sum_{i=1}^{\text{size}()}
+   * this->data[i]$.
    */
   DEAL_II_ALWAYS_INLINE
   Number
@@ -1227,7 +1228,8 @@ public:
   }
 
   /**
-   * Returns sum over entries of data field.
+   * Returns sum over entries of the data field, $\sum_{i=1}^{\text{size}()}
+   * this->data[i]$.
    */
   double
   sum();
@@ -1826,7 +1828,8 @@ public:
   }
 
   /**
-   * Returns sum over entries of data field.
+   * Returns sum over entries of the data field, $\sum_{i=1}^{\text{size}()}
+   * this->data[i]$.
    */
   float
   sum();
@@ -2530,7 +2533,8 @@ public:
   }
 
   /**
-   * Returns sum over entries of data field.
+   * Returns sum over entries of the data field, $\sum_{i=1}^{\text{size}()}
+   * this->data[i]$.
    */
   double
   sum();
@@ -3088,7 +3092,8 @@ public:
   }
 
   /**
-   * Returns sum over entries of data field.
+   * Returns sum over entries of the data field, $\sum_{i=1}^{\text{size}()}
+   * this->data[i]$.
    */
   float
   sum();
@@ -3676,7 +3681,8 @@ public:
   }
 
   /**
-   * Returns sum over entries of data field.
+   * Returns sum over entries of the data field, $\sum_{i=1}^{\text{size}()}
+   * this->data[i]$.
    */
   double
   sum();
@@ -4138,7 +4144,8 @@ public:
   }
 
   /**
-   * Returns sum over entries of data field.
+   * Returns sum over entries of the data field, $\sum_{i=1}^{\text{size}()}
+   * this->data[i]$.
    */
   float
   sum();

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.