Skip to content

Commit 6946b6b

Browse files
committed
Updated function input parameters, function header, and documentation.
1 parent 241230b commit 6946b6b

File tree

3 files changed

+13
-12
lines changed

3 files changed

+13
-12
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@ Most other references have <img src="https://latex.codecogs.com/svg.latex?\inlin
2424

2525
## Examples and Additional Documentation
2626

27-
- See "EXAMPLES.mlx" or the "Examples" tab on the File Exchange page for examples.
28-
- See "DOCUMENTATION.pdf" (included with download, also available at [https://github.com/tamaskis/tridiagonal-MATLAB/blob/main/DOCUMENTATION.pdf](https://github.com/tamaskis/tridiagonal-MATLAB/blob/main/DOCUMENTATION.pdf)) for additional documentation.
27+
- See "EXAMPLES.mlx" or the "Examples" tab on the File Exchange page for examples.
28+
- See ["Tridiagonal_Matrix_Algorithm__Thomas_Algorithm_.pdf"](https://tamaskis.github.io/documentation/Tridiagonal_Matrix_Algorithm__Thomas_Algorithm_.pdf) (also included with download) for the technical documentation.

DOCUMENTATION.pdf renamed to Tridiagonal_Matrix_Algorithm__Thomas_Algorithm_.pdf

227 KB
Binary file not shown.

tridiagonal.m

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,30 @@
88
% See also inv, gaussian_elimination.
99
%
1010
% Copyright © 2021 Tamas Kis
11+
% Last Update: 2021-08-28
12+
% Website: https://tamaskis.github.io
1113
12-
% Last Update: 2021-07-09
1314
%
14-
%--------------------------------------------------------------------------
15-
%
16-
% MATLAB Central File Exchange: https://www.mathworks.com/matlabcentral/fileexchange/85438-tridiagonal-matrix-algorithm-thomas-alg-tridiagonal
17-
% GitHub: https://github.com/tamaskis/tridiagonal-MATLAB
15+
% TECHNICAL DOCUMENTATION:
16+
% https://tamaskis.github.io/documentation/Tridiagonal_Matrix_Algorithm__Thomas_Algorithm_.pdf
1817
%
19-
% See EXAMPLES.mlx for examples and "DOCUMENTATION.pdf" for additional
20-
% documentation. Both of these files are included with the download.
18+
% REFERENCES:
19+
% [1] MATH 2620 Course Reader (Vanderbilt University)
20+
% [2] https://en.wikipedia.org/wiki/Tridiagonal_matrix_algorithm
21+
% [3] https://www.cfd-online.com/Wiki/Tridiagonal_matrix_algorithm_-_TDMA_(Thomas_algorithm)
2122
%
2223
%--------------------------------------------------------------------------
2324
%
2425
% ------
2526
% INPUT:
2627
% ------
27-
% A - (n×n) tridiagonal matrix
28-
% d - (n×1) vector
28+
% A - (n×n double) tridiagonal matrix
29+
% d - (n×1 double) vector
2930
%
3031
% -------
3132
% OUTPUT:
3233
% -------
33-
% x - (n×1) solution of the tridiagonal linear system Ax=d
34+
% x - (n×1 double) solution of the tridiagonal linear system Ax=d
3435
%
3536
%==========================================================================
3637
function x = tridiagonal(A,d)

0 commit comments

Comments
 (0)