summaryrefslogtreecommitdiff
path: root/help/en_US/cconv.xml
blob: 3cb0ea82dae119d8927110262ecc5ca2aeabb299 (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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
<?xml version="1.0" encoding="UTF-8"?>

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

<refentry version="5.0-subset Scilab" xml:id="cconv" 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>cconv</refname>
    <refpurpose> circularly convolves vectors a and b. n is the length of the resulting vector. </refpurpose>
  </refnamediv>

<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   o = cconv(a,b)
   o = cconv(a,b,n)
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>a:</term>
      <listitem><para> a real or complex vector.</para></listitem></varlistentry>
   <varlistentry><term>b:</term>
      <listitem><para> a real or complex vector.</para></listitem></varlistentry>
   <varlistentry><term>n:</term>
      <listitem><para> length of circular convolution</para></listitem></varlistentry>
   <varlistentry><term>o:</term>
      <listitem><para> convolution sequence</para></listitem></varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
This function buffers the given data into a matrix of signal frames
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
a=[1 2 3]
b=[4 5 6]
o=cconv(a,b,3)

//Output : o= 31  31  28
   ]]></programlisting>

   <programlisting role="example"><![CDATA[
a=[1 2+%i 4]
b=[2 3*%i 5]
o=cconv(a,b)
o=clean(o)

//Output:  o=  2.    4. + 5.i    10. + 6.i    10. + 17.i    20.
   ]]></programlisting>
</refsection>

</refentry>