diff scripts/polynomial/residue.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 diff
--- a/scripts/polynomial/residue.m	Sat Feb 04 10:29:50 2012 -0500
+++ b/scripts/polynomial/residue.m	Sat Feb 04 22:12:50 2012 -0800
@@ -33,9 +33,9 @@
 ##
 ## @example
 ## @group
-##  B(s)    M       r(m)         N
-##  ---- = SUM -------------  + SUM k(i)*s^(N-i)
-##  A(s)   m=1 (s-p(m))^e(m)    i=1
+## B(s)    M       r(m)         N
+## ---- = SUM -------------  + SUM k(i)*s^(N-i)
+## A(s)   m=1 (s-p(m))^e(m)    i=1
 ## @end group
 ## @end example
 ##
@@ -52,11 +52,11 @@
 ## @group
 ## b = [1, 1, 1];
 ## a = [1, -5, 8, -4];
-## [r, p, k, e] = residue (b, a);
-##      @result{} r = [-2; 7; 3]
-##      @result{} p = [2; 2; 1]
-##      @result{} k = [](0x0)
-##      @result{} e = [1; 2; 1]
+## [r, p, k, e] = residue (b, a)
+##    @result{} r = [-2; 7; 3]
+##    @result{} p = [2; 2; 1]
+##    @result{} k = [](0x0)
+##    @result{} e = [1; 2; 1]
 ## @end group
 ## @end example
 ##
@@ -95,12 +95,11 @@
 ## r = [-2; 7; 3];
 ## p = [2; 2; 1];
 ## k = [1, 0];
-## [b, a] = residue (r, p, k);
-##      @result{} b = [1, -5, 9, -3, 1]
-##      @result{} a = [1, -5, 8, -4]
+## [b, a] = residue (r, p, k)
+##    @result{} b = [1, -5, 9, -3, 1]
+##    @result{} a = [1, -5, 8, -4]
 ##
 ## where mpoles is used to determine e = [1; 2; 1]
-##
 ## @end group
 ## @end example
 ##
@@ -112,9 +111,9 @@
 ## p = [2; 1; 2];
 ## k = [1, 0];
 ## e = [2; 1; 1];
-## [b, a] = residue (r, p, k, e);
-##      @result{} b = [1, -5, 9, -3, 1]
-##      @result{} a = [1, -5, 8, -4]
+## [b, a] = residue (r, p, k, e)
+##    @result{} b = [1, -5, 9, -3, 1]
+##    @result{} a = [1, -5, 8, -4]
 ## @end group
 ## @end example
 ##
@@ -129,9 +128,9 @@
 ##
 ## @example
 ## @group
-##     -2        7        3         s^4 - 5s^3 + 9s^2 - 3s + 1
-##    ----- + ------- + ----- + s = --------------------------
-##    (s-2)   (s-2)^2   (s-1)          s^3 - 5s^2 + 8s - 4
+##  -2        7        3         s^4 - 5s^3 + 9s^2 - 3s + 1
+## ----- + ------- + ----- + s = --------------------------
+## (s-2)   (s-2)^2   (s-1)          s^3 - 5s^2 + 8s - 4
 ## @end group
 ## @end example
 ##