Skip to content

Commit e9d7f4e

Browse files
committed
Make examples self-contained
1 parent 9d61492 commit e9d7f4e

File tree

1 file changed

+39
-3
lines changed
  • lib/node_modules/@stdlib/math/base/tools/sum-series

1 file changed

+39
-3
lines changed

lib/node_modules/@stdlib/math/base/tools/sum-series/README.md

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,28 +81,64 @@ The `function` accepts the following `options`:
8181
By default, the initial value of the sum is `0`. To choose a different one, use the `initialValue` option.
8282

8383
```javascript
84-
var out = sumSeries( geometricSeriesGenerator( 0.5 ), {
84+
var pow = require( '@stdlib/math/base/special/pow' );
85+
86+
var out = sumSeries( geometricSeriesClosure( 0.5 ), {
8587
'initialValue': 1
8688
});
8789
// returns 3
90+
91+
function geometricSeriesClosure( x ) {
92+
var exponent = -1;
93+
return gen;
94+
95+
function gen() {
96+
exponent += 1;
97+
return pow( x, exponent );
98+
}
99+
}
88100
```
89101

90102
To change the maximum number of terms to be summed, set the `maxTerms` option.
91103

92104
```javascript
93-
var out = sumSeries( geometricSeriesGenerator( 0.5 ), {
105+
var pow = require( '@stdlib/math/base/special/pow' );
106+
107+
var out = sumSeries( geometricSeriesClosure( 0.5 ), {
94108
'maxTerms': 10
95109
});
96110
// returns ~1.998 (infinite sum is 2)
111+
112+
function geometricSeriesClosure( x ) {
113+
var exponent = -1;
114+
return gen;
115+
116+
function gen() {
117+
exponent += 1;
118+
return pow( x, exponent );
119+
}
120+
}
97121
```
98122

99123
The default tolerance of `2.22e-16` used to assess convergence can be changed via the `tolerance` option.
100124

101125
```javascript
102-
var out = sumSeries( geometricSeriesGenerator( 0.5 ), {
126+
var pow = require( '@stdlib/math/base/special/pow' );
127+
128+
var out = sumSeries( geometricSeriesClosure( 0.5 ), {
103129
'tolerance': 1e-3
104130
});
105131
// returns ~1.998
132+
133+
function geometricSeriesClosure( x ) {
134+
var exponent = -1;
135+
return gen;
136+
137+
function gen() {
138+
exponent += 1;
139+
return pow( x, exponent );
140+
}
141+
}
106142
```
107143

108144
</section>

0 commit comments

Comments
 (0)