|
1 | 1 | %========================================================================== |
2 | 2 | % |
3 | | -% fixed_point_iteration Calculates the fixed point of a univariate |
4 | | -% function using fixed-point iteration. |
| 3 | +% fixed_point_iteration Calculates the fixed point of a univariate, |
| 4 | +% scalar-valued function using fixed-point iteration. |
5 | 5 | % |
6 | 6 | % c = fixed_point_iteration(f,x0) |
7 | 7 | % c = fixed_point_iteration(f,x0,opts) |
8 | 8 | % |
| 9 | +% See also fzero, bisection_method, newtons_method, secant_method. |
| 10 | +% |
9 | 11 | % Copyright © 2021 Tamas Kis |
10 | | -% Last Update: 2021-11-22 |
| 12 | +% Last Update: 2021-12-11 |
11 | 13 | % Website: https://tamaskis.github.io |
12 | 14 | % Contact: tamas.a.kis@outlook.com |
13 | 15 | % |
|
22 | 24 | % ------ |
23 | 25 | % INPUT: |
24 | 26 | % ------ |
25 | | -% f - (function_handle) f(x) |
| 27 | +% f - (1×1 function_handle) univariate, scalar-valued function f(x) |
| 28 | +% (f:R->R) |
26 | 29 | % x0 - (1×1 double) initial guess for fixed point |
27 | | -% opts - (OPTIONAL) (struct) solver options structure |
| 30 | +% opts - (OPTIONAL) (1×1 struct) solver options |
28 | 31 | % • imax - (1×1 double) maximimum number of iterations |
29 | | -% • return_all - (logical) all intermediate fixed point estimates |
30 | | -% are returned if set to "true"; otherwise, a |
31 | | -% faster algorithm is used to return only the |
32 | | -% converged fixed point |
| 32 | +% • return_all - (1×1 logical) all intermediate fixed point |
| 33 | +% estimates are returned if set to "true"; |
| 34 | +% otherwise, a faster algorithm is used to return |
| 35 | +% only the converged fixed point |
33 | 36 | % • TOL - (1×1 double) tolerance |
34 | | -% • warnings - (logical) true if any warnings should be |
| 37 | +% • warnings - (1×1 logical) true if any warnings should be |
35 | 38 | % displayed, false if not |
36 | 39 | % |
37 | 40 | % ------- |
|
0 commit comments