Mercurial > octave

comparison scripts/linear-algebra/condest.m @ 20852:516bb87ea72e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
2015 Code Sprint: remove class of function from docstring for all m-files.
author Rik <rik@octave.org>
date Sat, 12 Dec 2015 07:31:00 -0800
parents b0f7ee81d974
children bfb1b089c230
comparison
equal deleted inserted replaced
20851:0828bf20d105 20852:516bb87ea72e
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} {} condest (@var{A}) 20 ## @deftypefn {} {} condest (@var{A})
21 ## @deftypefnx {Function File} {} condest (@var{A}, @var{t}) 21 ## @deftypefnx {} {} condest (@var{A}, @var{t})
22 ## @deftypefnx {Function File} {[@var{est}, @var{v}] =} condest (@dots{}) 22 ## @deftypefnx {} {[@var{est}, @var{v}] =} condest (@dots{})
23 ## @deftypefnx {Function File} {[@var{est}, @var{v}] =} condest (@var{A}, @var{solve}, @var{solve_t}, @var{t}) 23 ## @deftypefnx {} {[@var{est}, @var{v}] =} condest (@var{A}, @var{solve}, @var{solve_t}, @var{t})
24 ## @deftypefnx {Function File} {[@var{est}, @var{v}] =} condest (@var{apply}, @var{apply_t}, @var{solve}, @var{solve_t}, @var{n}, @var{t}) 24 ## @deftypefnx {} {[@var{est}, @var{v}] =} condest (@var{apply}, @var{apply_t}, @var{solve}, @var{solve_t}, @var{n}, @var{t})
25 ## 25 ##
26 ## Estimate the 1-norm condition number of a matrix @var{A} using @var{t} test 26 ## Estimate the 1-norm condition number of a matrix @var{A} using @var{t} test
27 ## vectors using a randomized 1-norm estimator. 27 ## vectors using a randomized 1-norm estimator.
28 ## 28 ##
29 ## If @var{t} exceeds 5, then only 5 test vectors are used. 29 ## If @var{t} exceeds 5, then only 5 test vectors are used.