Mercurial > octave-nkf

comparison scripts/polynomial/residue.m @ 14327:4d917a6a858b stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
14325:a646cee995cf 14327:4d917a6a858b
31 ## @end tex 31 ## @end tex
32 ## @ifnottex 32 ## @ifnottex
33 ## 33 ##
34 ## @example 34 ## @example
35 ## @group 35 ## @group
36 ## B(s) M r(m) N 36 ## B(s) M r(m) N
37 ## ---- = SUM ------------- + SUM k(i)*s^(N-i) 37 ## ---- = SUM ------------- + SUM k(i)*s^(N-i)
38 ## A(s) m=1 (s-p(m))^e(m) i=1 38 ## A(s) m=1 (s-p(m))^e(m) i=1
39 ## @end group 39 ## @end group
40 ## @end example 40 ## @end example
41 ## 41 ##
42 ## @end ifnottex 42 ## @end ifnottex
43 ## @noindent 43 ## @noindent
50 ## 50 ##
51 ## @example 51 ## @example
52 ## @group 52 ## @group
53 ## b = [1, 1, 1]; 53 ## b = [1, 1, 1];
54 ## a = [1, -5, 8, -4]; 54 ## a = [1, -5, 8, -4];
55 ## [r, p, k, e] = residue (b, a); 55 ## [r, p, k, e] = residue (b, a)
56 ## @result{} r = [-2; 7; 3] 56 ## @result{} r = [-2; 7; 3]
57 ## @result{} p = [2; 2; 1] 57 ## @result{} p = [2; 2; 1]
58 ## @result{} k = [](0x0) 58 ## @result{} k = [](0x0)
59 ## @result{} e = [1; 2; 1] 59 ## @result{} e = [1; 2; 1]
60 ## @end group 60 ## @end group
61 ## @end example 61 ## @end example
62 ## 62 ##
63 ## @noindent 63 ## @noindent
64 ## which represents the following partial fraction expansion 64 ## which represents the following partial fraction expansion
93 ## @example 93 ## @example
94 ## @group 94 ## @group
95 ## r = [-2; 7; 3]; 95 ## r = [-2; 7; 3];
96 ## p = [2; 2; 1]; 96 ## p = [2; 2; 1];
97 ## k = [1, 0]; 97 ## k = [1, 0];
98 ## [b, a] = residue (r, p, k); 98 ## [b, a] = residue (r, p, k)
99 ## @result{} b = [1, -5, 9, -3, 1] 99 ## @result{} b = [1, -5, 9, -3, 1]
100 ## @result{} a = [1, -5, 8, -4] 100 ## @result{} a = [1, -5, 8, -4]
101 ## 101 ##
102 ## where mpoles is used to determine e = [1; 2; 1] 102 ## where mpoles is used to determine e = [1; 2; 1]
103 ##
104 ## @end group 103 ## @end group
105 ## @end example 104 ## @end example
106 ## 105 ##
107 ## Alternatively the multiplicity may be defined explicitly, for example, 106 ## Alternatively the multiplicity may be defined explicitly, for example,
108 ## 107 ##
110 ## @group 109 ## @group
111 ## r = [7; 3; -2]; 110 ## r = [7; 3; -2];
112 ## p = [2; 1; 2]; 111 ## p = [2; 1; 2];
113 ## k = [1, 0]; 112 ## k = [1, 0];
114 ## e = [2; 1; 1]; 113 ## e = [2; 1; 1];
115 ## [b, a] = residue (r, p, k, e); 114 ## [b, a] = residue (r, p, k, e)
116 ## @result{} b = [1, -5, 9, -3, 1] 115 ## @result{} b = [1, -5, 9, -3, 1]
117 ## @result{} a = [1, -5, 8, -4] 116 ## @result{} a = [1, -5, 8, -4]
118 ## @end group 117 ## @end group
119 ## @end example 118 ## @end example
120 ## 119 ##
121 ## @noindent 120 ## @noindent
122 ## which represents the following partial fraction expansion 121 ## which represents the following partial fraction expansion
127 ## @end tex 126 ## @end tex
128 ## @ifnottex 127 ## @ifnottex
129 ## 128 ##
130 ## @example 129 ## @example
131 ## @group 130 ## @group
132 ## -2 7 3 s^4 - 5s^3 + 9s^2 - 3s + 1 131 ## -2 7 3 s^4 - 5s^3 + 9s^2 - 3s + 1
133 ## ----- + ------- + ----- + s = -------------------------- 132 ## ----- + ------- + ----- + s = --------------------------
134 ## (s-2) (s-2)^2 (s-1) s^3 - 5s^2 + 8s - 4 133 ## (s-2) (s-2)^2 (s-1) s^3 - 5s^2 + 8s - 4
135 ## @end group 134 ## @end group
136 ## @end example 135 ## @end example
137 ## 136 ##
138 ## @end ifnottex 137 ## @end ifnottex
139 ## @seealso{mpoles, poly, roots, conv, deconv} 138 ## @seealso{mpoles, poly, roots, conv, deconv}