Skip to content

Addition of TOCs in Markdown files #158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 21, 2020
Merged

Addition of TOCs in Markdown files #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a4f0791
toc_md: addition of TOC in Markdown files
jvdp1 Mar 14, 2020
a84d6b0
toc_md: correction of typos
jvdp1 Mar 14, 2020
8581207
toc_md: harmonization
jvdp1 Mar 14, 2020
883fb15
toc_md: removed Vim comments and subsection links
jvdp1 Mar 18, 2020
03b6133
toc_md: removed subtitle Implemented as proposed by Milan
jvdp1 Mar 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions src/stdlib_experimental_io.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
# IO

## Implemented

* `loadtxt`
* `open`
* `savetxt`

* [`loadtxt` - load a 2D array from a text file](#loadtxt---load-a-2d-array-from-a-text-file)
* [`open` - open a file](#open---open-a-file)
* [`savetxt` - save a 2D array into a text file](#savetxt---save-a-2d-array-into-a-text-file)

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

Expand Down
4 changes: 1 addition & 3 deletions src/stdlib_experimental_optval.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Default values for optional arguments

## Implemented

* `optval`
* [`optval` - fallback value for optional arguments](#optval---fallback-value-for-optional-arguments)

## `optval` - fallback value for optional arguments

Expand Down
20 changes: 14 additions & 6 deletions src/stdlib_experimental_quadrature.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# Numerical integration

## Implemented

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

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

### Description

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`.

### Syntax
Expand Down Expand Up @@ -46,6 +48,8 @@ end program

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

### Description

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.

### Syntax
Expand Down Expand Up @@ -78,7 +82,9 @@ end program

```

# `simps` - integrate sampled values using Simpson's rule
## `simps` - integrate sampled values using Simpson's rule (to be implemented)

### Description

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`.

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

TBD

# `simps_weights` - Simpson's rule weights for given abscissas
## `simps_weights` - Simpson's rule weights for given abscissas (to be implemented)

### Description

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.

Expand Down
21 changes: 0 additions & 21 deletions src/stdlib_experimental_stats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,8 @@
# Descriptive statistics


## Implemented
<!-- vim-markdown-toc GFM -->

* [`mean` - mean of array elements](#mean---mean-of-array-elements)
* [Description](#description)
* [Syntax](#syntax)
* [Arguments](#arguments)
* [Return value](#return-value)
* [Example](#example)
* [`moment` - central moment of array elements](#moment---central-moment-of-array-elements)
* [Description](#description-1)
* [Syntax](#syntax-1)
* [Arguments](#arguments-1)
* [Return value](#return-value-1)
* [Example](#example-1)
* [`var` - variance of array elements](#var---variance-of-array-elements)
* [Description](#description-2)
* [Syntax](#syntax-2)
* [Arguments](#arguments-2)
* [Return value](#return-value-2)
* [Example](#example-2)

<!-- vim-markdown-toc -->

## `mean` - mean of array elements

Expand Down