octave_packages/m/signal/sinewave.m

   1 ## Copyright (C) 1995-2012 Andreas Weingessel
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn {Function File} {} sinewave (@var{m}, @var{n}, @var{d})
  21 ## Return an @var{m}-element vector with @var{i}-th element given by
  22 ## @code{sin (2 * pi * (@var{i}+@var{d}-1) / @var{n})}.
  23 ##
  24 ## The default value for @var{d} is 0 and the default value for @var{n}
  25 ## is @var{m}.
  26 ## @end deftypefn
  27
  28 ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at>
  29 ## Description: Compute a sine wave
  30
  31 function x = sinewave (m, n, d)
  32
  33   if (nargin > 0 && nargin < 4)
  34     if (nargin < 3)
  35       d = 0;
  36     endif
  37     if (nargin < 2)
  38       n = m;
  39     endif
  40     x = sin (((1 : m) + d - 1) * 2 * pi / n);
  41   else
  42     print_usage ();
  43   endif
  44
  45 endfunction
  46
  47 %!assert (sinewave (1), 0);
  48 %!assert (sinewave (1, 4, 1), 1);
  49 %!assert (sinewave (1, 12, 1), 1/2, 1e-6);
  50 %!assert (sinewave (1, 12, 2), sqrt (3)/2, 1e-6);
  51 %!assert (sinewave (1, 20, 1), (sqrt (5)-1)/4, 1e-6);
  52 %!assert (sinewave (1), sinewave (1, 1,0));
  53 %!assert (sinewave (3, 4), sinewave(3, 4, 0));
  54
  55 %!error sinewave ();