Mercurial > octave
view scripts/special-matrix/hilb.m @ 14327:4d917a6a858b stable
doc: Use Octave coding conventions in @example blocks of docstrings.
* accumarray.m, accumdim.m, bar.m, base2dec.m, bincoeff.m, bitcmp.m, bitset.m,
celldisp.m, chop.m, clabel.m, cloglog.m, colon.m, compass.m, computer.m,
contour3.m, contourc.m, corr.m, cstrcat.m, ctime.m, cylinder.m, date.m,
dec2base.m, demo.m, dir.m, dlmwrite.m, expm.m, ezcontourf.m, ezcontour.m,
ezmeshc.m, ezmesh.m, ezplot.m, ezsurfc.m, ezsurf.m, feather.m, findobj.m,
flipdim.m, fplot.m, genvarname.m, getfield.m, hankel.m, hilb.m, hist.m,
idivide.m, index.m, int2str.m, interp1.m, is_leap_year.m, ismember.m,
isocolors.m, isonormals.m, isosurface.m, kurtosis.m, legendre.m, linkprop.m,
logit.m, logm.m, __makeinfo__.m, __marching_cube__.m, median.m, mkoctfile.m,
moment.m, mpoles.m, orderfields.m, pcg.m, pcr.m, plot3.m, plotmatrix.m,
polyaffine.m, polygcd.m, poly.m, polyout.m, print.m, qp.m, quadgk.m, qzhess.m,
randi.m, rat.m, refreshdata.m, residue.m, rose.m, rot90.m, saveas.m, saveobj.m,
shiftdim.m, skewness.m, spaugment.m, spdiags.m, sqp.m, stem.m, str2num.m,
strcat.m, strjust.m, strread.m, strsplit.m, structfun.m, subplot.m,
subsindex.m, substruct.m, surfl.m, surfnorm.m, svds.m, uimenu.m, union.m,
voronoi.m, warning_ids.m, wblpdf.m: Use Octave coding conventions in
@example blocks of docstrings.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Sat, 04 Feb 2012 22:12:50 -0800 |
parents | 72c96de7a403 |
children | f3d52523cde1 |
line wrap: on
line source
## Copyright (C) 1993-2012 John W. Eaton ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} hilb (@var{n}) ## Return the Hilbert matrix of order @var{n}. The @math{i,j} element ## of a Hilbert matrix is defined as ## @tex ## $$ ## H(i, j) = {1 \over (i + j - 1)} ## $$ ## @end tex ## @ifnottex ## ## @example ## H(i, j) = 1 / (i + j - 1) ## @end example ## ## @end ifnottex ## ## Hilbert matrices are close to being singular which make them difficult to ## invert with numerical routines. ## Comparing the condition number of a random matrix 5x5 matrix with that of ## a Hilbert matrix of order 5 reveals just how difficult the problem is. ## ## @example ## @group ## cond (rand (5)) ## @result{} 14.392 ## cond (hilb (5)) ## @result{} 4.7661e+05 ## @end group ## @end example ## ## @seealso{invhilb} ## @end deftypefn ## Author: jwe function retval = hilb (n) if (nargin != 1) print_usage (); elseif (! isscalar (n)) error ("hilb: N must be a scalar integer"); endif retval = zeros (n); tmp = 1:n; for i = 1:n retval(i, :) = 1.0 ./ tmp; tmp++; endfor endfunction %!assert (hilb (2), [1, 1/2; 1/2, 1/3]) %!assert (hilb (3), [1, 1/2, 1/3; 1/2, 1/3, 1/4; 1/3, 1/4, 1/5]) %!error hilb () %!error hilb (1, 2) %!error <N must be a scalar integer> hilb (ones(2))