Skip to content

Commit 5d1e091

Browse files
authored
Merge pull request #158 from jvdp1/toc_md
Addition of TOCs in Markdown files
2 parents fd4656d + 03b6133 commit 5d1e091

4 files changed

+18
-36
lines changed

src/stdlib_experimental_io.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
# IO
22

3-
## Implemented
4-
5-
* `loadtxt`
6-
* `open`
7-
* `savetxt`
8-
3+
* [`loadtxt` - load a 2D array from a text file](#loadtxt---load-a-2d-array-from-a-text-file)
4+
* [`open` - open a file](#open---open-a-file)
5+
* [`savetxt` - save a 2D array into a text file](#savetxt---save-a-2d-array-into-a-text-file)
96

107
## `loadtxt` - load a 2D array from a text file
118

src/stdlib_experimental_optval.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# Default values for optional arguments
22

3-
## Implemented
4-
5-
* `optval`
3+
* [`optval` - fallback value for optional arguments](#optval---fallback-value-for-optional-arguments)
64

75
## `optval` - fallback value for optional arguments
86

src/stdlib_experimental_quadrature.md

+14-6
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# Numerical integration
22

3-
## Implemented
4-
5-
* `trapz`
6-
* `trapz_weights`
3+
* [`trapz` - integrate sampled values using trapezoidal rule](#trapz---integrate-sampled-values-using-trapezoidal-rule)
4+
* [`trapz_weights` - trapezoidal rule weights for given abscissas](#trapz_weights---trapezoidal-rule-weights-for-given-abscissas)
5+
* [`simps` - integrate sampled values using Simpson's rule (to be implemented)](#simps---integrate-sampled-values-using-simpsons-rule-to-be-implemented)
6+
* [`simps_weights` - Simpson's rule weights for given abscissas (to be implemented)](#simps_weights---simpsons-rule-weights-for-given-abscissas-to-be-implemented)
77

88
## `trapz` - integrate sampled values using trapezoidal rule
99

10+
### Description
11+
1012
Returns the trapezoidal rule integral of an array `y` representing discrete samples of a function. The integral is computed assuming either equidistant abscissas with spacing `dx` or arbitary abscissas `x`.
1113

1214
### Syntax
@@ -46,6 +48,8 @@ end program
4648

4749
## `trapz_weights` - trapezoidal rule weights for given abscissas
4850

51+
### Description
52+
4953
Given an array of abscissas `x`, computes the array of weights `w` such that if `y` represented function values tabulated at `x`, then `sum(w*y)` produces a trapezoidal rule approximation to the integral.
5054

5155
### Syntax
@@ -78,7 +82,9 @@ end program
7882
7983
```
8084

81-
# `simps` - integrate sampled values using Simpson's rule
85+
## `simps` - integrate sampled values using Simpson's rule (to be implemented)
86+
87+
### Description
8288

8389
Returns the Simpson's rule integral of an array `y` representing discrete samples of a function. The integral is computed assuming either equidistant abscissas with spacing `dx` or arbitary abscissas `x`.
8490

@@ -112,7 +118,9 @@ If the size of `y` is two, the result is the same as if `trapz` had been called
112118

113119
TBD
114120

115-
# `simps_weights` - Simpson's rule weights for given abscissas
121+
## `simps_weights` - Simpson's rule weights for given abscissas (to be implemented)
122+
123+
### Description
116124

117125
Given an array of abscissas `x`, computes the array of weights `w` such that if `y` represented function values tabulated at `x`, then `sum(w*y)` produces a Simpson's rule approximation to the integral.
118126

src/stdlib_experimental_stats.md

-21
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,8 @@
11
# Descriptive statistics
22

3-
4-
## Implemented
5-
<!-- vim-markdown-toc GFM -->
6-
73
* [`mean` - mean of array elements](#mean---mean-of-array-elements)
8-
* [Description](#description)
9-
* [Syntax](#syntax)
10-
* [Arguments](#arguments)
11-
* [Return value](#return-value)
12-
* [Example](#example)
134
* [`moment` - central moment of array elements](#moment---central-moment-of-array-elements)
14-
* [Description](#description-1)
15-
* [Syntax](#syntax-1)
16-
* [Arguments](#arguments-1)
17-
* [Return value](#return-value-1)
18-
* [Example](#example-1)
195
* [`var` - variance of array elements](#var---variance-of-array-elements)
20-
* [Description](#description-2)
21-
* [Syntax](#syntax-2)
22-
* [Arguments](#arguments-2)
23-
* [Return value](#return-value-2)
24-
* [Example](#example-2)
25-
26-
<!-- vim-markdown-toc -->
276

287
## `mean` - mean of array elements
298

0 commit comments

Comments
 (0)