Skip to content

Commit 34c58c0

Browse files
committed
Add fftpack_kind doc
1 parent 254c73e commit 34c58c0

File tree

4 files changed

+22
-38
lines changed

4 files changed

+22
-38
lines changed

API-doc-FORD-file.md

Lines changed: 4 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ project_download: https://github.com/fortran-lang/fftpack/archive/HEAD.zip
2323
project_website: https://fortran-lang.github.io/fftpack/
2424
favicon: doc/media/favicon.ico
2525
license: by-sa
26-
author: Paul N. Swarztrauber & fortran-lang/fftpack contributors
26+
author: Paul N. Swarztrauber &
27+
fortran-lang/fftpack contributors
2728
author_pic: https://fortran-lang.org/assets/img/fortran_logo_512x512.png
2829
author_email: [email protected]
2930
github: https://github.com/fortran-lang
@@ -35,7 +36,7 @@ parallel: 4
3536

3637
[TOC]
3738

38-
@warning This API documentation for the Fortran-lang/fftpackis a work in progress.
39+
@warning This API documentation for the Fortran-lang/fftpack is a work in progress.
3940

4041
Fortran FFTPACK API Documentation
4142
=================================
@@ -47,37 +48,4 @@ The documentation for comment markup in source code, running [FORD] and the [FOR
4748
[FORD wiki]: https://github.com/Fortran-FOSS-Programmers/ford/wiki
4849
[FORD project file]: https://github.com/fortran-lang/fftpack/blob/HEAD/API-doc-FORD-file.md
4950

50-
A package of fortran subprograms for the fast fourier transform of periodic and other symmetric sequences.
51-
52-
## Getting started
53-
### Get the code
54-
```bash
55-
git clone https://github.com/fortran-lang/fftpack.git
56-
cd fftpack
57-
```
58-
59-
### Build with [fortran-lang/fpm](https://github.com/fortran-lang/fpm)
60-
Fortran Package Manager (fpm) is a package manager and build system for Fortran.
61-
You can build using provided `fpm.toml`:
62-
```bash
63-
fpm build
64-
fpm test --list
65-
fpm test <test_name, see `fpm.toml` or list>
66-
```
67-
To use `fftpack` within your `fpm` project, add the following to your `fpm.toml` file:
68-
```toml
69-
[dependencies]
70-
fftpack = { git="https://github.com/fortran-lang/fftpack.git" }
71-
```
72-
73-
## Build with Make
74-
Alternatively, you can build using provided `Makefile`:
75-
```bash
76-
make
77-
```
78-
79-
## Links
80-
- [netlib/dfftpack1.0(fftpack4.0)](http://www.netlib.org/fftpack/)
81-
- [Documents of fft routines in GNU/gsl based on `netlib/fftpack`](https://www.gnu.org/software/gsl/doc/html/fft.html#)
82-
- [Documents of scipy.fftpack](https://docs.scipy.org/doc/scipy/reference/fftpack.html)
83-
- [NACR/FFTPACK 5.1](https://www2.cisl.ucar.edu/resources/legacy/fft5)
51+
{!README.md!}

doc/specs/fftpack.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: FFTPACK
33
---
44

5-
# The `fftpack` module
5+
# The `fftpack` Module
66

77
[TOC]
88

doc/specs/fftpack_kind.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: FFTPACK Kind
3+
---
4+
5+
# The `fftpack_kind` Module
6+
7+
[TOC]
8+
9+
## Introduction
10+
11+
The `fftpack_kind` module provides kind parameters for FFTs.
12+
13+
## Constants provided by `fftpack_kind`
14+
15+
`rk`: **Double precision real kind parameter**. Provides real kind parameter for floating point numbers with a minimal precision of 15 significant digits.

doc/specs/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ title: Specifications (specs)
88

99
## Experimental Features & Modules
1010

11-
- [fftpack](./fftpack.html) - fftpack module.
11+
- [fftpack](./fftpack.html) - fftpack module.
12+
- [fftpack_kind](./fftpack_kind.html) - fftpack_kind module.
1213

1314
## Released/Stable Features & Modules
1415

0 commit comments

Comments
 (0)