Skip to content

Commit 1028348

Browse files
committed
READMEs: small style corrections
1 parent 22b6e55 commit 1028348

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

README

+6-6
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ INTERFACE
2020
---------
2121
All transform routines take three arguments:
2222

23-
* a pointer to input data,
24-
* a pointer to output data,
25-
* a pointer to auxiliary data.
23+
* input data pointer,
24+
* output data pointer,
25+
* auxiliary data pointer.
2626

2727
The transform routines are capable of both in-place and out-of-place
2828
operation. In the latter case the input is left intact.
2929

3030
Auxiliary data contain chains of precomputed constants and temporary
31-
memory buffers, required by a transform routine to do its job. Once
31+
memory buffers, required for a transform routine to do its job. Once
3232
prepared, the auxiliary data can be reused as many times as needed.
3333
Also, the same auxiliary data fit for both forward and inverse
3434
transforms of the same kind.
@@ -100,8 +100,8 @@ array dimensions must be passed in the reverse order:
100100

101101
Auxiliary data makers return NULL if an error occured.
102102

103-
Our definitions of transforms, and input and output data format of the
104-
transform routines, are fully compatible with FFTW.
103+
Our definitions of transforms, and formats of input and output data, are
104+
fully compatible with FFTW.
105105

106106
Complex DFT:
107107
minfft_aux* minfft_mkaux_dft_1d (int N);

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,15 @@ The library provides C and Fortran interfaces.
4040
## Interface
4141
All transform routines take three arguments:
4242

43-
* a pointer to input data `x`,
44-
* a pointer to output data `y`,
45-
* a pointer to auxiliary data `a`.
43+
* input data pointer `x`,
44+
* output data pointer `y`,
45+
* auxiliary data pointer `a`.
4646

4747
The transform routines are capable of both in-place and out-of-place
4848
operation. In the latter case the input is left intact.
4949

5050
Auxiliary data contain chains of precomputed constants and temporary
51-
memory buffers, required by a transform routine to do its job. Once
51+
memory buffers, required for a transform routine to do its job. Once
5252
prepared, the auxiliary data can be reused as many times as needed.
5353
Also, the same auxiliary data fit for both forward and inverse
5454
transforms of the same kind.
@@ -117,8 +117,8 @@ array dimensions must be passed in the reverse order:
117117

118118
Auxiliary data makers return NULL if an error occured.
119119

120-
Our definitions of transforms, and input and output data format of the
121-
transform routines, are fully compatible with FFTW.
120+
Our definitions of transforms, and formats of input and output data, are
121+
fully compatible with FFTW.
122122

123123
### Complex DFT
124124
![](docs/dft.svg)
@@ -256,7 +256,7 @@ void minfft_free_aux (minfft_aux *a);
256256
257257
## Memory requirements
258258
Our library does not try to save memory, and allocates temporary buffers
259-
where it benefits performance.
259+
wherever it benefits performance.
260260
261261
The amounts of memory, allocated for the auxiliary data of the
262262
one-dimensional transforms, are given below:

0 commit comments

Comments
 (0)