summaryrefslogtreecommitdiff
path: root/help/en_US/wind.xml
blob: 6402b7c2242602aab62149b70b7d7fcfb01836fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
<?xml version="1.0" encoding="UTF-8"?>

<!--
 *
 * This help file was generated from wind.sci using help_from_sci().
 *
 -->

<refentry version="5.0-subset Scilab" xml:id="wind" xml:lang="en"
          xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xmlns:svg="http://www.w3.org/2000/svg"
          xmlns:ns3="http://www.w3.org/1999/xhtml"
          xmlns:mml="http://www.w3.org/1998/Math/MathML"
          xmlns:scilab="http://www.scilab.org"
          xmlns:db="http://docbook.org/ns/docbook">

  <refnamediv>
    <refname>wind</refname>
    <refpurpose>This function creates an m-point window from the function f given as input.</refpurpose>
  </refnamediv>


<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   w = window(f, m)
   w = window(f, m, opts)
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>f:</term>
      <listitem><para> string value/window name</para></listitem></varlistentry>
   <varlistentry><term>m:</term>
      <listitem><para> positive integer value</para></listitem></varlistentry>
   <varlistentry><term>opts:</term>
      <listitem><para> string value, takes in "periodic" or "symmetric"</para></listitem></varlistentry>
   <varlistentry><term>w:</term>
      <listitem><para> output variable, vector of real numbers</para></listitem></varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
</para>
</refsection>
</refentry>