comparison scripts/linear-algebra/onenormest.m @ 10793:be55736a0783

Grammarcheck the documentation from m-files.
author Rik <octave@nomad.inbox5.com>
date Sun, 18 Jul 2010 20:35:16 -0700
parents 3140cb7a05a1
children 693e22af08ae
comparison
equal deleted inserted replaced
10792:91342260063e 10793:be55736a0783
15 ## You should have received a copy of the GNU General Public License 15 ## You should have received a copy of the GNU General Public License
16 ## along with Octave; see the file COPYING. If not, see 16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {[@var{est}, @var{v}, @var{w}, @var{iter}] =} onenormest (@var{a}, @var{t}) 20 ## @deftypefn {Function File} {[@var{est}, @var{v}, @var{w}, @var{iter}] =} onenormest (@var{a}, @var{t})
21 ## @deftypefnx {Function File} {[@var{est}, @var{v}, @var{w}, @var{iter}] =} onenormest (@var{apply}, @var{apply_t}, @var{n}, @var{t}) 21 ## @deftypefnx {Function File} {[@var{est}, @var{v}, @var{w}, @var{iter}] =} onenormest (@var{apply}, @var{apply_t}, @var{n}, @var{t})
22 ## 22 ##
23 ## Apply Higham and Tisseur's randomized block 1-norm estimator to 23 ## Apply Higham and Tisseur's randomized block 1-norm estimator to
24 ## matrix @var{a} using @var{t} test vectors. If @var{t} exceeds 5, then 24 ## matrix @var{a} using @var{t} test vectors. If @var{t} exceeds 5, then
25 ## only 5 test vectors are used. 25 ## only 5 test vectors are used.
37 ## and the number of iterations @var{iter}. The number of 37 ## and the number of iterations @var{iter}. The number of
38 ## iterations is limited to 10 and is at least 2. 38 ## iterations is limited to 10 and is at least 2.
39 ## 39 ##
40 ## References: 40 ## References:
41 ## @itemize 41 ## @itemize
42 ## @item N.J. Higham and F. Tisseur, @cite{A Block Algorithm 42 ## @item
43 ## N.J. Higham and F. Tisseur, @cite{A Block Algorithm
43 ## for Matrix 1-Norm Estimation, with an Application to 1-Norm 44 ## for Matrix 1-Norm Estimation, with an Application to 1-Norm
44 ## Pseudospectra}. SIMAX vol 21, no 4, pp 1185-1201. 45 ## Pseudospectra}. SIMAX vol 21, no 4, pp 1185-1201.
45 ## @url{http://dx.doi.org/10.1137/S0895479899356080} 46 ## @url{http://dx.doi.org/10.1137/S0895479899356080}
46 ## @item N.J. Higham and F. Tisseur, @cite{A Block Algorithm 47 ## @item
48 ## N.J. Higham and F. Tisseur, @cite{A Block Algorithm
47 ## for Matrix 1-Norm Estimation, with an Application to 1-Norm 49 ## for Matrix 1-Norm Estimation, with an Application to 1-Norm
48 ## Pseudospectra}. @url{http://citeseer.ist.psu.edu/223007.html} 50 ## Pseudospectra}. @url{http://citeseer.ist.psu.edu/223007.html}
49 ## @end itemize 51 ## @end itemize
50 ## 52 ##
51 ## @seealso{condest, norm, cond} 53 ## @seealso{condest, norm, cond}