Skip to content

Commit

Permalink
READMEs: small style corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
aimukhin committed Feb 2, 2021
1 parent 22b6e55 commit 1028348
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
12 changes: 6 additions & 6 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ INTERFACE
---------
All transform routines take three arguments:

* a pointer to input data,
* a pointer to output data,
* a pointer to auxiliary data.
* input data pointer,
* output data pointer,
* auxiliary data pointer.

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

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

Auxiliary data makers return NULL if an error occured.

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

Complex DFT:
minfft_aux* minfft_mkaux_dft_1d (int N);
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,15 @@ The library provides C and Fortran interfaces.
## Interface
All transform routines take three arguments:

* a pointer to input data `x`,
* a pointer to output data `y`,
* a pointer to auxiliary data `a`.
* input data pointer `x`,
* output data pointer `y`,
* auxiliary data pointer `a`.

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

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

Auxiliary data makers return NULL if an error occured.

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

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

0 comments on commit 1028348

Please sign in to comment.