External module "math/base/tools/sum-series/docs/types/index.d"

Export assignment sumSeries

• sumSeries(generator: Function, options?: Options): number

• Sum the elements of the series given by the supplied function.

  Parameters

  • generator: Function

    series function

  • Optional options: Options

    function options

  Returns number

  sum of all series terms

  Example

  var pow = require( `@stdlib/math/base/special/pow` );
  var gen = geometricSeriesGenerator( 0.9 );
  var out = sumSeries( gen );
  // returns 10.0
  
  function* geometricSeriesGenerator( x ) {
      var exponent = 0;
      while ( true ) {
          yield pow( x, exponent );
          exponent += 1;
      }
  }