summaryrefslogtreecommitdiff
path: root/help/en_US/clustersegment.xml
diff options
context:
space:
mode:
Diffstat (limited to 'help/en_US/clustersegment.xml')
-rw-r--r--help/en_US/clustersegment.xml60
1 files changed, 60 insertions, 0 deletions
diff --git a/help/en_US/clustersegment.xml b/help/en_US/clustersegment.xml
new file mode 100644
index 0000000..d3ab0ee
--- /dev/null
+++ b/help/en_US/clustersegment.xml
@@ -0,0 +1,60 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ *
+ * This help file was generated from clustersegment.sci using help_from_sci().
+ *
+ -->
+
+<refentry version="5.0-subset Scilab" xml:id="clustersegment" 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>clustersegment</refname>
+ <refpurpose>This function calculates boundary indexes of clusters of 1’s.</refpurpose>
+ </refnamediv>
+
+
+<refsynopsisdiv>
+ <title>Calling Sequence</title>
+ <synopsis>
+ c = clustersegment(s)
+ </synopsis>
+</refsynopsisdiv>
+
+<refsection>
+ <title>Parameters</title>
+ <variablelist>
+ <varlistentry><term>s:</term>
+ <listitem><para> scalar, vector or matrix of real numbers (clusters of 1s)</para></listitem></varlistentry>
+ <varlistentry><term>c:</term>
+ <listitem><para> output variable, cell array of size 1 by N, where N is the number of rows in s</para></listitem></varlistentry>
+ </variablelist>
+</refsection>
+
+<refsection>
+ <title>Description</title>
+ <para>
+This is an Octave function.
+This function calculates boundary indexes of clusters of 1’s.
+This function calculates the initial and end indices of the sequences of 1's present in the input argument.
+The output variable c is a cell array of size 1 by N, where N is the number of rows in s and each element has two rows indicating the initial index and end index of the cluster of 1's respectively. The indexing starts from 1.
+</para>
+</refsection>
+
+<refsection>
+ <title>Examples</title>
+ <programlisting role="example"><![CDATA[
+y = clustersegment ([0,1,0,0,1,1])
+y =
+2. 5.
+2. 6.
+ ]]></programlisting>
+</refsection>
+</refentry>