summaryrefslogtreecommitdiff
path: root/help/en_US/upsamplefill.xml
blob: 8a6e3528941841da41809d43acf7e4836d784b9c (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
<?xml version="1.0" encoding="UTF-8"?>

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

<refentry version="5.0-subset Scilab" xml:id="upsamplefill" 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>upsamplefill</refname>
    <refpurpose>This function upsamples a vector interleaving given values or copies of the vector elements.</refpurpose>
  </refnamediv>


<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   y = upsamplefill (x, w)
   y = upsamplefill (x, w, cpy)
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>x:</term>
      <listitem><para> scalar, vector or matrix of real or complex numbers</para></listitem></varlistentry>
   <varlistentry><term>w:</term>
      <listitem><para> scalar or vector of real or complex values</para></listitem></varlistentry>
   <varlistentry><term>cpy:</term>
      <listitem><para> can take in "true" or "false", default is false</para></listitem></varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
This is an Octave function.
This function upsamples a vector interleaving given values or copies of the vector elements.
The second argument has the values in the vector w that are placed in between the elements of x.
The third argument, if true, means that w should be scalar and that each value in x repeated w times.
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
upsamplefill([0.4,0.5],7)
ans  =
0.4    7.    0.5    7.
   ]]></programlisting>
</refsection>
</refentry>