Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xmjiao authored Jun 21, 2021
1 parent e66fa8b commit 309c7e1
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ Clone this project to your preferred location. Then start MATLAB or GNU Octave u

## Usage ##

The easiest way to use `hifir4m` is to call the `gmresHifir` interface. For example,
The easiest way to use `hifir4m` is to call the `gmresHif` interface. For example,
```matlab
>> [x, flag, relres, iter, reshis, times] = gmresHifir(A, b);
>> [x, flag, relres, iter, reshis, times] = gmresHif(A, b);
```
where `A` is a MATLAB's built-in sparse matrix or a `MATLAB` `struct` containing the filds of `row_ptr`, `col_ind`, `vals` of a standard CRS storage format, and `b` is a right-hand-side vector (or RHS vectors with two columns).

To access the intermediate-level interfaces of `hifir4m`, please see `gmresHifir.m` for the calling sequence of `hifCreate`, `hifApply`, and `hifDestroy`.
To access the intermediate-level interfaces of `hifir4m`, please see `gmresHif.m` for the calling sequence of `hifCreate`, `hifApply`, and `hifDestroy`.

## Copyright and Licenses ##

Expand Down

0 comments on commit 309c7e1

Please sign in to comment.