update packages

[CreaPhase.git] / octave_packages / m / signal / sinewave.m

diff --git a/octave_packages/m/signal/sinewave.m b/octave_packages/m/signal/sinewave.m
new file mode 100644 (file)
index 0000000..a5ab362
--- /dev/null
+++ b/octave_packages/m/signal/sinewave.m
@@ -0,0 +1,55 @@
+## Copyright (C) 1995-2012 Andreas Weingessel
+##
+## This file is part of Octave.
+##
+## Octave is free software; you can redistribute it and/or modify it
+## under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 3 of the License, or (at
+## your option) any later version.
+##
+## Octave is distributed in the hope that it will be useful, but
+## WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+## General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with Octave; see the file COPYING.  If not, see
+## <http://www.gnu.org/licenses/>.
+
+## -*- texinfo -*-
+## @deftypefn {Function File} {} sinewave (@var{m}, @var{n}, @var{d})
+## Return an @var{m}-element vector with @var{i}-th element given by
+## @code{sin (2 * pi * (@var{i}+@var{d}-1) / @var{n})}.
+##
+## The default value for @var{d} is 0 and the default value for @var{n}
+## is @var{m}.
+## @end deftypefn
+
+## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at>
+## Description: Compute a sine wave
+
+function x = sinewave (m, n, d)
+
+  if (nargin > 0 && nargin < 4)
+    if (nargin < 3)
+      d = 0;
+    endif
+    if (nargin < 2)
+      n = m;
+    endif
+    x = sin (((1 : m) + d - 1) * 2 * pi / n);
+  else
+    print_usage ();
+  endif
+
+endfunction
+
+%!assert (sinewave (1), 0);
+%!assert (sinewave (1, 4, 1), 1);
+%!assert (sinewave (1, 12, 1), 1/2, 1e-6);
+%!assert (sinewave (1, 12, 2), sqrt (3)/2, 1e-6);
+%!assert (sinewave (1, 20, 1), (sqrt (5)-1)/4, 1e-6);
+%!assert (sinewave (1), sinewave (1, 1,0));
+%!assert (sinewave (3, 4), sinewave(3, 4, 0));
+
+%!error sinewave ();