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

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

<refentry version="5.0-subset Scilab" xml:id="sigmoid_train" 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>sigmoid_train</refname>
    <refpurpose>Evaluate a train of sigmoid functions at t.</refpurpose>
    <para> </para>
  </refnamediv>


<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   y = sigmoid_train(t, ranges, rc)
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>t:</term>
      <listitem><para> integer</para></listitem></varlistentry>
   <varlistentry><term>ranges:</term>
      <listitem><para> matrix</para></listitem></varlistentry>
   <varlistentry><term>rc:</term>
      <listitem><para> time constant (scalar)</para></listitem></varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
The number and duration of each sigmoid is determined from RANGES. Each row of RANGES represents a real interval, e.g.  if sigmoid 'i' starts at 't=0.1' and ends at 't=0.5', then 'RANGES(i,:) = [0.1 0.5]'.  The input RC is an array that defines the rising and falling time constants of each sigmoid.  Its size must equal the size of RANGES.
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
sigmoid_train(0.1,[1:3],4)
   ]]></programlisting>
</refsection>
</refentry>