view examples/code/@polynomial/polynomial_superiorto.m @ 21070:fd97ed44f2da

doc: Use more coding conventions in Object Oriented reference example code. * examples/code/@FIRfilter/FIRfilter.m, examples/code/@FIRfilter/FIRfilter_aggregation.m, examples/code/@FIRfilter/subsasgn.m, examples/code/@FIRfilter/subsref.m, examples/code/@polynomial/display.m, examples/code/@polynomial/double.m, examples/code/@polynomial/get.m, examples/code/@polynomial/mtimes.m, examples/code/@polynomial/numel.m, examples/code/@polynomial/polynomial.m, examples/code/@polynomial/polynomial_superiorto.m, examples/code/@polynomial/polyval.m, examples/code/@polynomial/roots.m, examples/code/@polynomial/set.m, examples/code/@polynomial/subsasgn.m, examples/code/@polynomial/subsref.m: Remove "Function File" from deftypefn. Use names of variables in error messages. Surround invalid items in error messages with single quotes. Use meaningful variable names.
author Rik <rik@octave.org>
date Thu, 14 Jan 2016 09:59:07 -0800
parents 73ab962bc52d
children 28de41192f3c
line wrap: on
line source

## -*- texinfo -*-
## @deftypefn  {} {} polynomial ()
## @deftypefnx {} {} polynomial (@var{a})
## Create a polynomial object representing the polynomial
##
## @example
## a0 + a1 * x + a2 * x^2 + @dots{} + an * x^n
## @end example
##
## @noindent
## from a vector of coefficients [a0 a1 a2 @dots{} an].
## @end deftypefn

function p = polynomial (a)

  if (nargin > 1)
    print_usage ();
  endif

  if (nargin == 0)
    p.poly = [0];
    p = class (p, "polynomial");
  else
    if (strcmp (class (a), "polynomial"))
      p = a;
    elseif (isreal (a) && isvector (a))
      p.poly = a(:).';  # force row vector
      p = class (p, "polynomial");
    else
      error ("@polynomial: A must be a real vector");
    endif
  endif

  superiorto ("double");

endfunction