Commit 64ca27aee7e7cc8d2f600fa942dc862d6acfbf25

Authored by Jürgen Knödlseder
1 parent 27146b7d

Update Doxygen documentatuion of romb() method.

Showing 1 changed file with 4 additions and 3 deletions
src/numerics/GIntegral.cpp
... ... @@ -187,13 +187,14 @@ GIntegral* GIntegral::clone(void) const
187 187 * @param[in] k Integration order (default: k=5)
188 188 *
189 189 * Returns the integral of the integrand from a to b. Integration is
190   - * performed by Romberg's method of order 2K, where e.g. K=2 in Simpson's
191   - * rule.
  190 + * performed by Romberg's method of order 2k, where
  191 + * k=1 is equivalent to the trapezoidal rule,
  192 + * k=2 is equivalent to Simpson's rule, and
  193 + * k=3 is equivalent to Boole's rule.
192 194 * The number of iterations is limited by m_max_iter. m_eps specifies the
193 195 * requested fractional accuracy. By default it is set to 1e-6.
194 196 *
195 197 * @todo Check that k is smaller than m_max_iter
196   - * @todo Make use of std::vector class
197 198 ***************************************************************************/
198 199 double GIntegral::romb(const double& a, const double& b, const int& k)
199 200 {
... ...