view examples/@FIRfilter/FIRfilter_aggregation.m @ 9251:f8b8ab529913

improve OOP documentation
author Robert T. Short <octave@phaselockedsystems.com>
date Sun, 24 May 2009 10:23:07 -0700
parents
children 050bc580cb60
line wrap: on
line source

## -*- texinfo -*-
## @deftypefn {Function File} {} FIRfilter ()
## @deftypefnx {Function File} {} FIRfilter (@var{p})
## Creates an FIR filter with polynomial @var{p} as
## coefficient vector.
##
## @end deftypefn

function f = FIRfilter (p)

  if (nargin == 0)
    f.polynomial = @polynomial ([1]);
  elseif (nargin == 1)
    if (isa (p, "polynomial"))
      f.polynomial = p;
    else
      error ("FIRfilter: expecting polynomial as input argument");
    endif
  else
    print_usage ();
  endif
  f = class (f, "FIRfilter");
endfunction