comparison scripts/polynomial/polyaffine.m @ 10821:693e22af08ae

Grammarcheck documentation of m-files Add newlines between @item fields for readability.
author Rik <octave@nomad.inbox5.com>
date Mon, 26 Jul 2010 21:25:36 -0700
parents 09da0bd91412
children 2c356a35d7f5
comparison
equal deleted inserted replaced
10820:c44c786f87ba 10821:693e22af08ae
15 15
16 ## -*- texinfo -*- 16 ## -*- texinfo -*-
17 ## @deftypefn {Function File} {} polyaffine (@var{f}, @var{mu}) 17 ## @deftypefn {Function File} {} polyaffine (@var{f}, @var{mu})
18 ## Return the coefficients of the polynomial whose coefficients are given by 18 ## Return the coefficients of the polynomial whose coefficients are given by
19 ## vector @var{f} after an affine tranformation. If @var{f} is the vector 19 ## vector @var{f} after an affine tranformation. If @var{f} is the vector
20 ## representing the polynomial f(x), then @var{g} = polytrans (@var{f}, 20 ## representing the polynomial f(x), then @code{@var{g} = polyaffine (@var{f},
21 ## @var{mu}) is the vector representing 21 ## @var{mu})} is the vector representing
22 ##
22 ## @example 23 ## @example
23 ## g(x) = f((x-@var{mu}(1))/@var{mu}(2)). 24 ## g(x) = f((x-@var{mu}(1))/@var{mu}(2)).
24 ## @end example 25 ## @end example
25 ## 26 ##
26 ## @seealso{polyval} 27 ## @seealso{polyval}
32 if (nargin != 2) 33 if (nargin != 2)
33 print_usage (); 34 print_usage ();
34 endif 35 endif
35 36
36 if (! isvector (f)) 37 if (! isvector (f))
37 error ("polyaffine: first argument must be a vector."); 38 error ("polyaffine: F must be a vector.");
38 endif 39 endif
39 40
40 if (! isvector (mu) || length (mu) != 2) 41 if (! isvector (mu) || length (mu) != 2)
41 error ("polyaffine: second argument must be a two-element vector."); 42 error ("polyaffine: MU must be a two-element vector.");
42 endif 43 endif
43 44
44 lf = length (f); 45 lf = length (f);
45 46
46 ## Ensure that f is a row vector 47 ## Ensure that f is a row vector