diff options
| author | rupak | 2019-10-10 12:57:46 +0530 |
|---|---|---|
| committer | rupak | 2019-10-10 12:57:46 +0530 |
| commit | ac01f75eaa0475879647e8c6e1343e4c49d7c18c (patch) | |
| tree | ceefa71219ca3021f572323b6f0217e0f8fab93b | |
| parent | 999122e511f5f2cabdff0bb26908db4e57dfcee2 (diff) | |
| download | fossee-scilab-octave-toolbox-ac01f75eaa0475879647e8c6e1343e4c49d7c18c.tar.gz fossee-scilab-octave-toolbox-ac01f75eaa0475879647e8c6e1343e4c49d7c18c.tar.bz2 fossee-scilab-octave-toolbox-ac01f75eaa0475879647e8c6e1343e4c49d7c18c.zip | |
added help for toolbox
58 files changed, 1195 insertions, 540 deletions
@@ -2,19 +2,21 @@ //cd /home/rupak/scilab-toolbox/scilab_octave/ -if (~isfile("build.sce")) then - cd ../../ -end -pwd +//if (~isfile("build.sce")) then +// cd ../../ +//end +//pwd try exec unloader.sce end exec cleaner.sce clear -ulink +try ulink +end +help_from_sci("macros","help/en_US") exec builder.sce exec loader.sce diff --git a/builder.sce b/builder.sce index 2f9cbfc..20e9300 100644 --- a/builder.sce +++ b/builder.sce @@ -7,8 +7,8 @@ mode(-1); lines(0); function main_builder() - TOOLBOX_NAME = "scilab_toolbox"; - TOOLBOX_TITLE = "scilab_toolbox"; + TOOLBOX_NAME = "scilab_octave"; + TOOLBOX_TITLE = "scilab_octave"; toolbox_dir = get_absolute_file_path("builder.sce"); // Check Scilab's version @@ -38,7 +38,7 @@ function main_builder() tbx_builder_macros(toolbox_dir); tbx_builder_gateway(toolbox_dir); tbx_build_localization(toolbox_dir); - // tbx_builder_help(toolbox_dir); + tbx_builder_help(toolbox_dir); tbx_build_loader(toolbox_dir); tbx_build_cleaner(toolbox_dir); diff --git a/etc/scilab_toolbox.start b/etc/scilab_toolbox.start index 47d9a10..d1fc447 100644 --- a/etc/scilab_toolbox.start +++ b/etc/scilab_toolbox.start @@ -5,8 +5,8 @@ function scilab_toolboxlib = startModule() - TOOLBOX_NAME = "scilab_toolbox"; - TOOLBOX_TITLE = "scilab_toolbox"; + TOOLBOX_NAME = "scilab_octave"; + TOOLBOX_TITLE = "scilab_octave"; mprintf("Start " + TOOLBOX_TITLE + "\n"); diff --git a/help/builder_help.sce b/help/builder_help.sce index 8f93d27..cceebb0 100644 --- a/help/builder_help.sce +++ b/help/builder_help.sce @@ -1,8 +1,12 @@ // This file is released under the 3-clause BSD license. See COPYING-BSD. -here = get_absolute_file_path("builder_help.sce"); -d = dir(here); -d = d.name(d.isdir); -la_LA = d(grep(d, "/[a-z]{2}_[A-Z]{2}/", "r")); // filtering out ./images/ ./mml/, ... -tbx_builder_help_lang(la_LA, here); -clear here d la_LA +mode(-1) +lines(0) + +toolbox_title = "scilab_octave" + +help_dir = get_absolute_file_path('builder_help.sce'); + +tbx_builder_help_lang("en_US", help_dir); + +clear toolbox_title; diff --git a/help/en_US/addchapter.sce b/help/en_US/addchapter.sce new file mode 100644 index 0000000..4c45ef6 --- /dev/null +++ b/help/en_US/addchapter.sce @@ -0,0 +1,5 @@ +// This file is released under the 3-clause BSD license. See COPYING-BSD. +// Generated by tbx_build_help_loader: Please, do not edit this file + +add_help_chapter("scilab_octave",get_absolute_file_path("addchapter.sce"),%F); +clear add_help_chapter; diff --git a/help/en_US/c_multiplybypi.xml b/help/en_US/c_multiplybypi.xml deleted file mode 100644 index 469fc4e..0000000 --- a/help/en_US/c_multiplybypi.xml +++ /dev/null @@ -1,55 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - * This file is released under the 3-clause BSD license. See COPYING-BSD. - * - --> -<refentry 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:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="c_multiplybypi" xml:lang="en"> - <refnamediv> - <refname>c_multiplybypi</refname> - <refpurpose>multiply by %pi a number</refpurpose> - </refnamediv> - <refsynopsisdiv> - <title>Syntax</title> - <synopsis>a = multiplybypi(b)</synopsis> - </refsynopsisdiv> - <refsection> - <title>Arguments</title> - <variablelist> - <varlistentry> - <term>b</term> - <listitem> - <para>first input argument</para> - </listitem> - </varlistentry> - <varlistentry> - <term>a</term> - <listitem> - <para>output argument</para> - </listitem> - </varlistentry> - </variablelist> - </refsection> - <refsection> - <title>Description</title> - <para>Do a special multiplication.</para> - <para>Add here a paragraph of the function description </para> - <para> - LaTeX can also be used to render equation: In this case, the rendering should <latex>$x*\pi$</latex> - </para> - </refsection> - <refsection> - <title>Examples</title> - <programlisting role="example">c_multiplybypi(3)</programlisting> - </refsection> - <refsection role="see also"> - <title>See also</title> - <simplelist type="inline"> - <member> - <link linkend="c_sum">c_sum</link> - </member> - <member> - <link type="scilab" linkend="scilab.help/sum">Link to the Scilab help page</link> - </member> - </simplelist> - </refsection> -</refentry> diff --git a/help/en_US/c_sub.xml b/help/en_US/c_sub.xml deleted file mode 100644 index 9b82fc2..0000000 --- a/help/en_US/c_sub.xml +++ /dev/null @@ -1,82 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - * This file is released under the 3-clause BSD license. See COPYING-BSD. - * - --> -<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:scilab="http://www.scilab.org" 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:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="c_sub" xml:lang="en"> - <refnamediv> - <refname>c_sub</refname> - <refpurpose>subtraction from C</refpurpose> - </refnamediv> - <refsynopsisdiv> - <title>Syntax</title> - <synopsis>a = c_sub(b,c)</synopsis> - </refsynopsisdiv> - <refsection> - <title>Arguments</title> - <variablelist> - <varlistentry> - <term>b</term> - <listitem> - <para>first input argument</para> - </listitem> - </varlistentry> - <varlistentry> - <term>c</term> - <listitem> - <para>second input argument</para> - </listitem> - </varlistentry> - <varlistentry> - <term>a</term> - <listitem> - <para>output argument</para> - </listitem> - </varlistentry> - </variablelist> - </refsection> - <refsection> - <title>Description</title> - <para>Do a subtraction.</para> - <para>Add here a paragraph of the function description </para> - <para> - LaTeX can also be used to render equation: In this case, the rendering should <latex>$x-y$</latex> - </para> - <para>It is now possible to include an image in using Scilab code (this requires to declare the namespace xmlns:scilab="http://www.scilab.org"):</para> - <programlisting role="xml"> - <![CDATA[ - <scilab:image> - plot3d(); - </scilab:image> - ]]> - </programlisting> - <scilab:image> - plot3d(); - </scilab:image> - <para>If an image contains a localized string then the attribute scilab:localized="true" is required:</para> - <programlisting role="xml"> - <![CDATA[ - <scilab:image localized="true"> - plot2d(); - xtitle("My Beautiful 2D plots"); - </scilab:image> - ]]> - </programlisting> - <scilab:image localized="true"> - plot2d(); - xtitle("My Beautiful 2D plots"); - </scilab:image> - </refsection> - <refsection> - <title>Examples</title> - <programlisting role="example">c_sub(3,4)</programlisting> - </refsection> - <refsection role="see also"> - <title>See also</title> - <simplelist type="inline"> - <member> - <link linkend="c_sum">c_sum</link> - </member> - </simplelist> - </refsection> -</refentry> diff --git a/help/en_US/c_sum.xml b/help/en_US/c_sum.xml deleted file mode 100644 index fe04116..0000000 --- a/help/en_US/c_sum.xml +++ /dev/null @@ -1,61 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - * This file is released under the 3-clause BSD license. See COPYING-BSD. - * - --> -<refentry 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:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="c_sum" xml:lang="en"> - <refnamediv> - <refname>c_sum</refname> - <refpurpose>sum from C</refpurpose> - </refnamediv> - <refsynopsisdiv> - <title>Syntax</title> - <synopsis>a = c_sum(b,c)</synopsis> - </refsynopsisdiv> - <refsection> - <title>Arguments</title> - <variablelist> - <varlistentry> - <term>b</term> - <listitem> - <para>first input argument</para> - </listitem> - </varlistentry> - <varlistentry> - <term>c</term> - <listitem> - <para>second input argument</para> - </listitem> - </varlistentry> - <varlistentry> - <term>a</term> - <listitem> - <para>output argument</para> - </listitem> - </varlistentry> - </variablelist> - </refsection> - <refsection> - <title>Description</title> - <para>Do a sum.</para> - <para>Add here a paragraph of the function description </para> - <para> - LaTeX can also be used to render equation: In this case, the rendering should <latex>$x+y$</latex> - </para> - </refsection> - <refsection> - <title>Examples</title> - <programlisting role="example">c_sum(3,4)</programlisting> - </refsection> - <refsection role="see also"> - <title>See also</title> - <simplelist type="inline"> - <member> - <link linkend="fortran_sum">fortran_sum</link> - </member> - <member> - <link type="scilab" linkend="scilab.help/sum">Link to the Scilab help page</link> - </member> - </simplelist> - </refsection> -</refentry> diff --git a/help/en_US/fortran_sum.xml b/help/en_US/fortran_sum.xml deleted file mode 100644 index a2f9a31..0000000 --- a/help/en_US/fortran_sum.xml +++ /dev/null @@ -1,60 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - * This file is released under the 3-clause BSD license. See COPYING-BSD. - --> -<refentry 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:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="fortran_sum" xml:lang="en"> - <refnamediv> - <refname>fortran_sum</refname> - <refpurpose>sum from fortran</refpurpose> - </refnamediv> - <refsynopsisdiv> - <title>Syntax</title> - <synopsis>a = fortran_sum(b,c)</synopsis> - </refsynopsisdiv> - <refsection> - <title>Arguments</title> - <variablelist> - <varlistentry> - <term>b</term> - <listitem> - <para>first input argument</para> - </listitem> - </varlistentry> - <varlistentry> - <term>c</term> - <listitem> - <para>second input argument</para> - </listitem> - </varlistentry> - <varlistentry> - <term>a</term> - <listitem> - <para>output argument</para> - </listitem> - </varlistentry> - </variablelist> - </refsection> - <refsection> - <title>Description</title> - <para>Do a sum.</para> - <para>Add here a paragraph of the function description</para> - <para> - LaTeX can also be used to render equation: In this case, the rendering should <latex>$x+y$</latex> - </para> - </refsection> - <refsection> - <title>Examples</title> - <programlisting role="example">fortran_sum(3,4)</programlisting> - </refsection> - <refsection role="see also"> - <title>See also</title> - <simplelist type="inline"> - <member> - <link linkend="c_sum">c_sum</link> - </member> - <member> - <link type="scilab" linkend="scilab.help/sum">Link to the Scilab help page</link> - </member> - </simplelist> - </refsection> -</refentry> diff --git a/help/en_US/master_help.xml b/help/en_US/master_help.xml new file mode 100644 index 0000000..275890c --- /dev/null +++ b/help/en_US/master_help.xml @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book [ +<!--Begin Entities--> +<!ENTITY a2ed2d4be3584d8c38302185542e7a55c SYSTEM "/home/rupak/scilab-toolbox/scilab_octave/help/en_US/octave_fun.xml"> +<!--End Entities--> +]> +<book version="5.0-subset Scilab" xml:lang="en_US" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:html="http://www.w3.org/1999/xhtml" + xmlns:db="http://docbook.org/ns/docbook"> + <info xml:id='scilab_octave_manual'> + <title>scilab_octave</title> + </info> + +<part xml:id='section_597319ec0f8f262cff8ce5d679429f35'> +<title>scilab_octave</title> +&a2ed2d4be3584d8c38302185542e7a55c; +</part> +</book> diff --git a/help/en_US/octave_fun.xml b/help/en_US/octave_fun.xml new file mode 100644 index 0000000..bfbb118 --- /dev/null +++ b/help/en_US/octave_fun.xml @@ -0,0 +1,143 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from octave_fun.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="octave_fun" 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>octave_fun</refname> + <refpurpose>Calls an octave function with given inputs and returns the expected output</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Syntax</title> + <synopsis> + [y1, y2, ...] = octave_fun("octave_function",input1,input2,...) + [y1, y2, ...] = octave_fun("octave_function",input1,input2,...,optional_input1,optional_input2,...) + [y1, y2, ...] = octave_fun("octave_function","octave_package",input1,input2,...) + [y1, y2, ...] = octave_fun("octave_function","octave_package",input1,input2,...,optional_input1,optional_input2,...) + + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry> + <term>y :</term> + <listitem><para> ouput as returned by octave. It can be a vector or matrix of doubles</para></listitem> + </varlistentry> + <varlistentry> + <term>octave_function :</term> + <listitem><para> name of the function in octave that has to be called. It has to be a string in double quotes</para></listitem> + </varlistentry> + <varlistentry> + <term>input :</term> + <listitem><para> input as expected by the octave function. It can be a vector or matrix of doubles</para></listitem> + </varlistentry> + <varlistentry> + <term>optional_input :</term> + <listitem><para> an optional argument that the given octave function can accept. It has to be a string in double quotes</para></listitem> + </varlistentry> + <varlistentry> + <term>octave_package :</term> + <listitem><para> name of the package in octave that has to be loaded as required by the octave function. It has to be a string in double quotes</para></listitem> + </varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This function accepts an octave function name with the relevant inputs and returns the output as generated. It requires Octave to be installed along with necessary packages. + </para> + <para> +<latex> +\begin{eqnarray} +&\mbox{min}_{x} +& C^Tâ‹…x \\ +& \text{subject to}& Aâ‹…x = b \\ +& & Gâ‹…x \preceq_K h \\ +& & x_i \in \{0,1\}, i \in \!\, bool_vars\ +& & x_j \in \!\, \mathbb{Z}, i \in \!\, int_vars\\ +\end{eqnarray} +</latex> + </para> + <para> +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +// Finding the inverse of a matrix using octave +A=[1 2 3;4 5 6;7 8 0] +y = octave_fun("inv",A) +y*A + + ]]></programlisting> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ + +// Finding the roots of a polynomial using its coefficients as inputs, using octave +p = [1 2 3]; +y = octave_fun("roots",p) + + ]]></programlisting> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ + +// Generating filter coefficients of a Hamming window of length M, using octave. +M = 5 +y = octave_fun("hamming",M) + + ]]></programlisting> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ + +// Generating filter coefficients of a Hamming window of length M with optional arguments, using octave. +M = 5 +y = octave_fun("hamming",M,"periodic") + + + ]]></programlisting> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ + +// Generating an elliptic or Cauer filter with given passband ripple and stopband attenuation, using octave and its "signal" package. See help in octave for more information about "ellip" function +[b, a]=octave_fun("ellip","signal",5,1,90,[0.1 0.2]) + + ]]></programlisting> +</refsection> + +<refsection> + <title>Authors</title> + <simplelist type="vert"> + <member>Rupak Rokade</member> + </simplelist> +</refsection> +</refentry> diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS b/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS Binary files differnew file mode 100644 index 0000000..9ed5472 --- /dev/null +++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS.TAB b/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS.TAB Binary files differnew file mode 100644 index 0000000..744a232 --- /dev/null +++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS.TAB diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/OFFSETS b/help/en_US/scilab_en_US_help/JavaHelpSearch/OFFSETS new file mode 100644 index 0000000..c3c7752 --- /dev/null +++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/OFFSETS @@ -0,0 +1 @@ +‡PƒÎÀk`
\ No newline at end of file diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/POSITIONS b/help/en_US/scilab_en_US_help/JavaHelpSearch/POSITIONS Binary files differnew file mode 100644 index 0000000..1f3a4f5 --- /dev/null +++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/POSITIONS diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/SCHEMA b/help/en_US/scilab_en_US_help/JavaHelpSearch/SCHEMA new file mode 100644 index 0000000..ea929e5 --- /dev/null +++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/SCHEMA @@ -0,0 +1,2 @@ +JavaSearch 1.0 +TMAP bs=2048 rt=0 fl=-1 id1=119 id2=1 diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/TMAP b/help/en_US/scilab_en_US_help/JavaHelpSearch/TMAP Binary files differnew file mode 100644 index 0000000..452fdba --- /dev/null +++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/TMAP diff --git a/help/en_US/scilab_en_US_help/ScilabCaution.png b/help/en_US/scilab_en_US_help/ScilabCaution.png Binary files differnew file mode 100644 index 0000000..98d26d9 --- /dev/null +++ b/help/en_US/scilab_en_US_help/ScilabCaution.png diff --git a/help/en_US/scilab_en_US_help/ScilabEdit.png b/help/en_US/scilab_en_US_help/ScilabEdit.png Binary files differnew file mode 100644 index 0000000..e3ad3b8 --- /dev/null +++ b/help/en_US/scilab_en_US_help/ScilabEdit.png diff --git a/help/en_US/scilab_en_US_help/ScilabExecute.png b/help/en_US/scilab_en_US_help/ScilabExecute.png Binary files differnew file mode 100644 index 0000000..9bfead1 --- /dev/null +++ b/help/en_US/scilab_en_US_help/ScilabExecute.png diff --git a/help/en_US/scilab_en_US_help/ScilabImportant.png b/help/en_US/scilab_en_US_help/ScilabImportant.png Binary files differnew file mode 100644 index 0000000..7793271 --- /dev/null +++ b/help/en_US/scilab_en_US_help/ScilabImportant.png diff --git a/help/en_US/scilab_en_US_help/ScilabNote.png b/help/en_US/scilab_en_US_help/ScilabNote.png Binary files differnew file mode 100644 index 0000000..d32cffa --- /dev/null +++ b/help/en_US/scilab_en_US_help/ScilabNote.png diff --git a/help/en_US/scilab_en_US_help/ScilabTip.png b/help/en_US/scilab_en_US_help/ScilabTip.png Binary files differnew file mode 100644 index 0000000..d32cffa --- /dev/null +++ b/help/en_US/scilab_en_US_help/ScilabTip.png diff --git a/help/en_US/scilab_en_US_help/ScilabWarning.png b/help/en_US/scilab_en_US_help/ScilabWarning.png Binary files differnew file mode 100644 index 0000000..98d26d9 --- /dev/null +++ b/help/en_US/scilab_en_US_help/ScilabWarning.png diff --git a/help/en_US/scilab_en_US_help/c_code.css b/help/en_US/scilab_en_US_help/c_code.css new file mode 100644 index 0000000..948d2ee --- /dev/null +++ b/help/en_US/scilab_en_US_help/c_code.css @@ -0,0 +1,54 @@ +.ccomment { + font-style: italic; + color: #b22222 +} + +.cdefault { + font-style: normal; + color: #000000 +} + +.copenclose { + font-style: normal; + color: #000000 +} + +.coperator { + font-style: normal; + color: #000000 +} + +.cstring { + font-style: normal; + color: #a6557a +} + +.ctype { + font-style: normal; + color: #55a655 +} + +.cpreprocessor { + font-style: normal; + color: #9965a6 +} + +.cid { + font-style: normal; + color: #000000 +} + +.ckeyword { + font-style: normal; + color: #ad3ff2 +} + +.cmodifier { + font-style: normal; + color: #ad3ff2 +} + +.cnumber { + font-style: normal; + color: #008b8b +} diff --git a/help/en_US/scilab_en_US_help/index.html b/help/en_US/scilab_en_US_help/index.html new file mode 100644 index 0000000..e39997b --- /dev/null +++ b/help/en_US/scilab_en_US_help/index.html @@ -0,0 +1,55 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title></title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + + </td> + <td width="40%" class="center"> + + </td> + <td width="30%" class="next"> + + </td> + </tr></table> + <hr /> + </div> + + + + + <br /><br /> + <h3 class="book-title">scilab_octave</h3> +<ul class="list-part"><a name="scilab_octave_manual"></a><div class="info"></div> + +<li><a href="section_597319ec0f8f262cff8ce5d679429f35.html" class="part">scilab_octave</a> +<ul class="list-chapter"><li><a href="octave_fun.html" class="refentry">octave_fun</a> — <span class="refentry-description">Calls an octave function with given inputs and returns the expected output</span></li></ul></li></ul> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + + </td> + <td width="40%" class="center"> + + </td> + <td width="30%" class="next"> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/jhelpidx.xml b/help/en_US/scilab_en_US_help/jhelpidx.xml new file mode 100644 index 0000000..aa5a66e --- /dev/null +++ b/help/en_US/scilab_en_US_help/jhelpidx.xml @@ -0,0 +1,3 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE index PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp Index Version 1.0//EN" "http://java.sun.com/products/javahelp/index_1_0.dtd"> +<index version="1.0"/>
\ No newline at end of file diff --git a/help/en_US/scilab_en_US_help/jhelpmap.jhm b/help/en_US/scilab_en_US_help/jhelpmap.jhm new file mode 100644 index 0000000..db10acc --- /dev/null +++ b/help/en_US/scilab_en_US_help/jhelpmap.jhm @@ -0,0 +1,7 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE map PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp Map Version 1.0//EN" "http://java.sun.com/products/javahelp/map_1_0.dtd"> +<map version="1.0"> +<mapID target="index" url="index.html"/> +<mapID target="section_597319ec0f8f262cff8ce5d679429f35" url="section_597319ec0f8f262cff8ce5d679429f35.html"/> +<mapID target="octave_fun" url="octave_fun.html"/> +</map>
\ No newline at end of file diff --git a/help/en_US/scilab_en_US_help/jhelpset.hs b/help/en_US/scilab_en_US_help/jhelpset.hs new file mode 100644 index 0000000..5b2ffe5 --- /dev/null +++ b/help/en_US/scilab_en_US_help/jhelpset.hs @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE helpset + PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp HelpSet Version 1.0//EN" "http://java.sun.com/products/javahelp/helpset_1_0.dtd"> +<helpset version="1.0"> +<title>scilab_octave</title> +<maps> +<homeID>top</homeID> +<mapref location="jhelpmap.jhm"/> +</maps> +<view> +<name>TOC</name> +<label>Table Of Contents</label> +<type>javax.help.TOCView</type> +<data>jhelptoc.xml</data> +</view> +<view> +<name>Index</name> +<label>Index</label> +<type>javax.help.IndexView</type> +<data>jhelpidx.xml</data> +</view> +<view> +<name>Search</name> +<label>Search</label> +<type>javax.help.SearchView</type> +<data engine="com.sun.java.help.search.DefaultSearchEngine">JavaHelpSearch</data> +</view> +</helpset>
\ No newline at end of file diff --git a/help/en_US/scilab_en_US_help/jhelptoc.xml b/help/en_US/scilab_en_US_help/jhelptoc.xml new file mode 100644 index 0000000..5eb0f55 --- /dev/null +++ b/help/en_US/scilab_en_US_help/jhelptoc.xml @@ -0,0 +1,9 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE toc PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp TOC Version 1.0//EN" "http://java.sun.com/products/javahelp/toc_1_0.dtd"> +<toc version="1.0"> +<tocitem target="index" text="scilab_octave"> +<tocitem target="section_597319ec0f8f262cff8ce5d679429f35" text="scilab_octave"> +<tocitem target="octave_fun" text="octave_fun"/> +</tocitem> +</tocitem> +</toc>
\ No newline at end of file diff --git a/help/en_US/scilab_en_US_help/octave_fun.html b/help/en_US/scilab_en_US_help/octave_fun.html new file mode 100644 index 0000000..c586a94 --- /dev/null +++ b/help/en_US/scilab_en_US_help/octave_fun.html @@ -0,0 +1,109 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>octave_fun</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="section_597319ec0f8f262cff8ce5d679429f35.html"><< scilab_octave</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_597319ec0f8f262cff8ce5d679429f35.html">scilab_octave</a></span> + + </td> + <td width="30%" class="next"> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">scilab_octave</a> >> <a href="section_597319ec0f8f262cff8ce5d679429f35.html">scilab_octave</a> > octave_fun</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">octave_fun</h1> + <p class="refpurpose">Calls an octave function with given inputs and returns the expected output</p></div> + + +<div class="refsynopsisdiv"><h3 class="title">Syntax</h3> + <div class="synopsis"><pre><span class="default">[</span><span class="default">y1</span><span class="default">, </span><span class="default">y2</span><span class="default">, ...] = </span><span class="functionid">octave_fun</span><span class="default">(</span>"<span class="default">octave_function</span>"<span class="default">,</span><span class="default">input1</span><span class="default">,</span><span class="default">input2</span><span class="default">,...)</span> +<span class="default">[</span><span class="default">y1</span><span class="default">, </span><span class="default">y2</span><span class="default">, ...] = </span><span class="functionid">octave_fun</span><span class="default">(</span>"<span class="default">octave_function</span>"<span class="default">,</span><span class="default">input1</span><span class="default">,</span><span class="default">input2</span><span class="default">,...,</span><span class="default">optional_input1</span><span class="default">,</span><span class="default">optional_input2</span><span class="default">,...)</span> +<span class="default">[</span><span class="default">y1</span><span class="default">, </span><span class="default">y2</span><span class="default">, ...] = </span><span class="functionid">octave_fun</span><span class="default">(</span>"<span class="default">octave_function</span>"<span class="default">,</span>"<span class="default">octave_package</span>"<span class="default">,</span><span class="default">input1</span><span class="default">,</span><span class="default">input2</span><span class="default">,...)</span> +<span class="default">[</span><span class="default">y1</span><span class="default">, </span><span class="default">y2</span><span class="default">, ...] = </span><span class="functionid">octave_fun</span><span class="default">(</span>"<span class="default">octave_function</span>"<span class="default">,</span>"<span class="default">octave_package</span>"<span class="default">,</span><span class="default">input1</span><span class="default">,</span><span class="default">input2</span><span class="default">,...,</span><span class="default">optional_input1</span><span class="default">,</span><span class="default">optional_input2</span><span class="default">,...)</span></pre></div></div> + +<div class="refsection"><h3 class="title">Parameters</h3> + <dl><dt><span class="term">y :</span> + <dd><p class="para">ouput as returned by octave. It can be a vector or matrix of doubles</p></dd></dt> + <dt><span class="term">octave_function :</span> + <dd><p class="para">name of the function in octave that has to be called. It has to be a string in double quotes</p></dd></dt> + <dt><span class="term">input :</span> + <dd><p class="para">input as expected by the octave function. It can be a vector or matrix of doubles</p></dd></dt> + <dt><span class="term">optional_input :</span> + <dd><p class="para">an optional argument that the given octave function can accept. It has to be a string in double quotes</p></dd></dt> + <dt><span class="term">octave_package :</span> + <dd><p class="para">name of the package in octave that has to be loaded as required by the octave function. It has to be a string in double quotes</p></dd></dt></dl></div> + +<div class="refsection"><h3 class="title">Description</h3> + <p class="para">This function accepts an octave function name with the relevant inputs and returns the output as generated. It requires Octave to be installed along with necessary packages.</p> + <p class="para"></p> + <p class="para"></p></div> + +<div class="refsection"><h3 class="title">Examples</h3> + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabcomment">// Finding the inverse of a matrix using octave</span> +<span class="scilabid">A</span><span class="scilaboperator">=</span><span class="scilabopenclose">[</span><span class="scilabnumber">1</span> <span class="scilabnumber">2</span> <span class="scilabnumber">3</span><span class="scilabdefault">;</span><span class="scilabnumber">4</span> <span class="scilabnumber">5</span> <span class="scilabnumber">6</span><span class="scilabdefault">;</span><span class="scilabnumber">7</span> <span class="scilabnumber">8</span> <span class="scilabnumber">0</span><span class="scilabopenclose">]</span> +<span class="scilabid">y</span> <span class="scilaboperator">=</span> <span class="scilabid">octave_fun</span><span class="scilabopenclose">(</span><span class="scilabstring">"</span><span class="scilabstring">inv</span><span class="scilabstring">"</span><span class="scilabdefault">,</span><span class="scilabid">A</span><span class="scilabopenclose">)</span> +<span class="scilabid">y</span><span class="scilaboperator">*</span><span class="scilabid">A</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + +<div class="refsection"><h3 class="title">Examples</h3> + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabcomment">// Finding the roots of a polynomial using its coefficients as inputs, using octave</span> +<span class="scilabid">p</span> <span class="scilaboperator">=</span> <span class="scilabopenclose">[</span><span class="scilabnumber">1</span> <span class="scilabnumber">2</span> <span class="scilabnumber">3</span><span class="scilabopenclose">]</span><span class="scilabdefault">;</span> +<span class="scilabid">y</span> <span class="scilaboperator">=</span> <span class="scilabid">octave_fun</span><span class="scilabopenclose">(</span><span class="scilabstring">"</span><span class="scilabstring">roots</span><span class="scilabstring">"</span><span class="scilabdefault">,</span><span class="scilabid">p</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + +<div class="refsection"><h3 class="title">Examples</h3> + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabcomment">// Generating filter coefficients of a Hamming window of length M, using octave.</span> +<span class="scilabid">M</span> <span class="scilaboperator">=</span> <span class="scilabnumber">5</span> +<span class="scilabid">y</span> <span class="scilaboperator">=</span> <span class="scilabid">octave_fun</span><span class="scilabopenclose">(</span><span class="scilabstring">"</span><span class="scilabstring">hamming</span><span class="scilabstring">"</span><span class="scilabdefault">,</span><span class="scilabid">M</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + +<div class="refsection"><h3 class="title">Examples</h3> + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabcomment">// Generating filter coefficients of a Hamming window of length M with optional arguments, using octave.</span> +<span class="scilabid">M</span> <span class="scilaboperator">=</span> <span class="scilabnumber">5</span> +<span class="scilabid">y</span> <span class="scilaboperator">=</span> <span class="scilabid">octave_fun</span><span class="scilabopenclose">(</span><span class="scilabstring">"</span><span class="scilabstring">hamming</span><span class="scilabstring">"</span><span class="scilabdefault">,</span><span class="scilabid">M</span><span class="scilabdefault">,</span><span class="scilabstring">"</span><span class="scilabstring">periodic</span><span class="scilabstring">"</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + +<div class="refsection"><h3 class="title">Examples</h3> + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabcomment">// Generating an elliptic or Cauer filter with given passband ripple and stopband attenuation, using octave and its </span><span class="scilabcomment">"</span><span class="scilabcomment">signal</span><span class="scilabcomment">"</span><span class="scilabcomment"> package. See help in octave for more information about </span><span class="scilabcomment">"</span><span class="scilabcomment">ellip</span><span class="scilabcomment">"</span><span class="scilabcomment"> function</span> +<span class="scilabopenclose">[</span><span class="scilabid">b</span><span class="scilabdefault">,</span> <span class="scilabid">a</span><span class="scilabopenclose">]</span><span class="scilaboperator">=</span><span class="scilabid">octave_fun</span><span class="scilabopenclose">(</span><span class="scilabstring">"</span><span class="scilabstring">ellip</span><span class="scilabstring">"</span><span class="scilabdefault">,</span><span class="scilabstring">"</span><span class="scilabstring">signal</span><span class="scilabstring">"</span><span class="scilabdefault">,</span><span class="scilabnumber">5</span><span class="scilabdefault">,</span><span class="scilabnumber">1</span><span class="scilabdefault">,</span><span class="scilabnumber">90</span><span class="scilabdefault">,</span><span class="scilabopenclose">[</span><span class="scilabnumber">0.1</span> <span class="scilabnumber">0.2</span><span class="scilabopenclose">]</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + +<div class="refsection"><h3 class="title">Authors</h3> + <ul class="itemizedlist"><li class="member">Rupak Rokade</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="section_597319ec0f8f262cff8ce5d679429f35.html"><< scilab_octave</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_597319ec0f8f262cff8ce5d679429f35.html">scilab_octave</a></span> + + </td> + <td width="30%" class="next"> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/scilab_code.css b/help/en_US/scilab_en_US_help/scilab_code.css new file mode 100644 index 0000000..658f42e --- /dev/null +++ b/help/en_US/scilab_en_US_help/scilab_code.css @@ -0,0 +1,96 @@ +.scilabcomment { + font-style: italic; + color: #01a801 +} + +.scilabdefault { + font-style: normal; + color: #000000 +} + +.scilabspecial { + font-style: normal; + color: #ffaa00 +} + +.scilabconstants { + font-style: normal; + color: #da70d6 +} + +.scilaboperator { + font-style: normal; + color: #5c5c5c +} + +.scilabnumber { + font-style: normal; + color: #bc8f8f +} + +.scilabfkeyword { + font-style: normal; + color: #b01813 +} + +.scilabskeyword { + font-style: normal; + color: #a020f0 +} + +.scilabckeyword { + font-style: normal; + color: #5f9ea0 +} + +.scilabcommand { + font-style: normal; + color: #32b9b9 +} + +.scilabmacro { + font-style: normal; + color: #ae5cb0 +} + +a.scilabcommand { + font-style: normal; + text-decoration: underline; + color: #32b9b9 +} + +a.scilabmacro { + font-style: normal; + text-decoration: underline; + color: #ae5cb0 +} + +.scilabstring { + font-style: normal; + color: #bc8f8f +} + +.scilabid { + font-style: normal; + color: #000000 +} + +.scilabinputoutputargs { + font-weight: bold; + color: #834310 +} + +.scilabfunctionid { + font-weight: bold; + color: #000000 +} + +.scilabfield { + font-style: normal; + color: #aaaaaa +} + +.scilabopenclose { + font-style: normal; + color: #4a55db +} diff --git a/help/en_US/scilab_en_US_help/section_597319ec0f8f262cff8ce5d679429f35.html b/help/en_US/scilab_en_US_help/section_597319ec0f8f262cff8ce5d679429f35.html new file mode 100644 index 0000000..a828712 --- /dev/null +++ b/help/en_US/scilab_en_US_help/section_597319ec0f8f262cff8ce5d679429f35.html @@ -0,0 +1,55 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title></title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="index.html">scilab_octave</a></span> + + </td> + <td width="30%" class="next"> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">scilab_octave</a> >> scilab_octave</span> + + <br /><br /> + <h3 class="title-part">scilab_octave</h3> +<ul class="list-chapter"><li><a href="octave_fun.html" class="refentry">octave_fun</a> — <span class="refentry-description">Calls an octave function with given inputs and returns the expected output</span></li></ul> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="index.html">scilab_octave</a></span> + + </td> + <td width="30%" class="next"> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/style.css b/help/en_US/scilab_en_US_help/style.css new file mode 100644 index 0000000..93bd898 --- /dev/null +++ b/help/en_US/scilab_en_US_help/style.css @@ -0,0 +1,378 @@ +body { + color:#000000; + background-color:#ffffff; + font-family:sans-serif; + font-size:100%; + margin:5px; + padding:0; + background : url("/img/body.png"); + background-repeat : repeat-x; +} + +.para { + padding-left: 10px; +} + +.refname { + color: #ff6c0a; +} +.refpurpose { + font-size: 110%; +} + +.synopsis { + border: 1px solid #CCCCCC; + width:80%; + padding: 0.5em; +} + +.editbar { + text-align: right; +} + +.term { + color:#A00000; + font-size:100%; + font-weight: 600; +} + +h3 { + color: #0033FF; + font-weight: bold; + font-size:130%; + margin-bottom: 10px; +} + +h4 { + color: #0066FF; + font-weight: bold; + font-size:120%; + margin-bottom: 5px; +} + +h5 { + color: #0099FF; + font-weight: bold; + font-size:110%; + margin-bottom: 1px; +} + +.programlisting { + font-family: monospace; + font-size: 100%; + background-color:#F4F4FF; + border-color:#CCCCCC; + border-style:solid; + border-width:2px medium; + width:90%; + color:#333333; + line-height:120%; + padding:10px; +} + +.literal { + font-family: monospace; + font-size: 100%; +} + +.option { + font-family: monospace; + font-style: italic; + font-size: 100%; +} + +.command { + font-family: monospace; + font-size: 100%; + color: #32b9b9; +} + +.function { + font-family: monospace; + font-size: 100%; + color: #32b9b9; +} + +.varname { + font-family: monospace; + font-weight: bold; + font-size: 100%; +} + +.constant { + font-family: monospace; + font-size: 100%; + color: #da70d6; +} + +a { + color: blue; + text-decoration:none; +} + +a:hover { + text-decoration:underline; +} + +.itemizedlist { + list-style-type: disc; +} + +.inline-list li { + display: inline; + list-style-type: disc; +} + +.vert-list { + list-style-type: disc; +} + +pre { + margin-bottom: 0px; + margin-top: 0px; +} + +.leftpart { + position:absolute; + float:left; + width: 186px; + padding: 5px; + font-size: smaller; +} + +.content { + margin-top: 100px; + margin-left: 196px +} + +.container { + margin: 0 auto; + width:1024px; +} + +ul.toc li.list-active { + list-style-type:disc; + font-weight:bold; +} + +ul.toc li.parent { + font-size: 115%; + padding: 5px 0px 5px 11px; + border-bottom: 1px solid #cccccc; + margin-bottom: 5px; +} + +ul.toc li.root { + font-size: 135%; + padding: 5px 0px 5px 11px; + border-bottom: 1px solid #cccccc; + margin-bottom: 5px; +} + +ul.toc li { + font-size: 85%; + margin: 1px 0 1px 1px; + padding: 1px 0 1px 11px; + background-repeat: no-repeat; + background-position: center left; + list-style-type: circle; +} + +.next { + float:right; + text-align: right; +} + +.center { + text-align: center; +} + +.screen { + font-family: monospace; + font-size: 100%; + background-color:#FFFFFF; + border-color:#CCCCCC; + border-style:solid; + border-width:2px medium; + width:90%; + color:#333333; + line-height:120%; + padding:10px; +} + +/* Top and bottom navigation controls on manual pages --------------------- */ +div.manualnavbar { + background-color: #F0F0FF; + color: inherit; + padding: 4px; + margin-bottom: 10px; +} +div.manualnavbar .prev { + padding-right: 4px; +} +div.manualnavbar .next { + text-align: right; + padding-left: 4px; +} + +div.manualnavbar .top { + text-align: center; + display: block; +} + +div.manualnavbar hr { + color: #cccccc; + background-color: #cccccc; +} + +/* Footer navigation area ------------------------------------------------- */ + +#pagefooter { + position: relative; + font-size: 75%; + color: inherit; + background-color: #e5e5e5; + width: 100%; +} + +#pagefooterleft { + top: 0px; + left: 0px; + padding: 6px; + margin-right: 30%; +} + +#pagefooterright { + text-align: right; + margin-left: 50%; + padding: 6px; +} +#footnav { + color: inherit; + background-color: #9999cc; + border-width: 1px 0px; + border-color: #333366; + border-style: solid; + text-align: right; + padding-right: 6px; +} + + + + + #global{ +/* width: 90%; */ + max-width: 90em; +/* min-width: 850px; */ + margin-left: auto; + margin-right: auto; + } + + #myHeader{ + background-color:#000000; + color:white; + margin-bottom : 10px; + position : relative; + text-align: center; +/* width : 1024px;*/ + height : 100px; + padding-left : 20px; + background : url("http://atoms.scilab.org/images/homepage/cadre_head.png"); + background-repeat : no-repeat; + background-position : 0px 0px; + + } + + #myFooter{ + background-color:#E5E5E5; + font-color:black; +/* width: 90%;*/ + max-width: 90em; +/* min-width: 850px; + margin-left: 5%; + margin-right: 5%;*/ + margin-top:10px; + padding:10px; + } + + #mainArea{ + width: 100%; + overflow: hidden; + } + + #myLeftArea{ + color:white; + float: left; + width: 180px; + padding:5px; + } + + #myMiddleArea{ + color:black; + margin-left: 200px; + padding: 10px 20px; + } + + #myRightArea{ + color:white; + float: right; + width: 200px; + padding: 12px 20px; + } + + +div#cadre_head +{ + position : relative; + text-align: center; +/* width : 1024px;*/ + height : 100px; + padding-left : 20px; + background : url("/img/cadre_head.png"); + background-repeat : no-repeat; + background-position : 0px 0px; +} + + +div#slogan{ + position: absolute; + top : 50px; + left:251px; + color:#0000AA; + font: 120%, Georgia,Serif; +} +div#cadre_help +{ + position: absolute; + top:45px; + right:0px; + font-size:0.8em; + color:#0000AA; +} +table +{ + border-collapse:collapse +} +th, td { + padding: 4px; +} +table.revhistory +{ + width:90%; + border-color:#CCCCCC; + border-style:solid; + border-width:2px medium; + margin-bottom: 10px; +} + +table.revhistory tr.title td +{ + background-color: #CCCCEE; + font-weight: bold; +} + +td.revnumber +{ + vertical-align: top; +} + diff --git a/help/en_US/scilab_en_US_help/xml_code.css b/help/en_US/scilab_en_US_help/xml_code.css new file mode 100644 index 0000000..9e4c27f --- /dev/null +++ b/help/en_US/scilab_en_US_help/xml_code.css @@ -0,0 +1,94 @@ +.xmlcomment { + font-style: italic; + color: #01a801 +} + +.xmldefault { + font-style: normal; + color: #000000 +} + +.xmlentity { + font-style: normal; + color: #ffaa00 +} + +.xmlopeninstr { + font-style: normal; + color: #000000 +} + +.xmlcloseinstr { + font-style: normal; + color: #000000 +} + +.xmlinstrname { + font-style: normal; + color: #9965a6 +} + +.xmllowtag { + font-style: normal; + color: #000000 +} + +.xmltagname { + font-style: normal; + color: #0303ff +} + +.xmllowclose { + font-style: normal; + color: #000000 +} + +.xmlopencomment { + font-style: italic; + color: #01a801 +} + +.xmlcommentend { + font-style: italic; + color: #01a801 +} + +.xmlcomment { + font-style: italic; + color: #01a801 +} + +.xmlopencdata { + font-style: normal; + color: #c45555 +} + +.xmlcdataend { + font-style: normal; + color: #c45555 +} + +.xmlcdata { + font-style: normal; + color: #000000 +} + +.xmlattributename { + font-style: normal; + color: #9965a6 +} + +.xmlequal { + font-style: normal; + color: #000000 +} + +.xmlattributevalue { + font-style: normal; + color: #973964 +} + +.xmlautoclose { + font-style: normal; + color: #000000 +} diff --git a/help/en_US/scilab_sum.xml b/help/en_US/scilab_sum.xml deleted file mode 100644 index 5a6bdb5..0000000 --- a/help/en_US/scilab_sum.xml +++ /dev/null @@ -1,62 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - * - * This file is released under the 3-clause BSD license. See COPYING-BSD. - * - --> -<refentry 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:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="scilab_sum" xml:lang="en"> - <refnamediv> - <refname>scilab_sum</refname> - <refpurpose>sum from scilab</refpurpose> - </refnamediv> - <refsynopsisdiv> - <title>Syntax</title> - <synopsis>a = scilab_sum(b,c)</synopsis> - </refsynopsisdiv> - <refsection> - <title>Arguments</title> - <variablelist> - <varlistentry> - <term>b</term> - <listitem> - <para>first input argument</para> - </listitem> - </varlistentry> - <varlistentry> - <term>c</term> - <listitem> - <para>second input argument</para> - </listitem> - </varlistentry> - <varlistentry> - <term>a</term> - <listitem> - <para>output argument</para> - </listitem> - </varlistentry> - </variablelist> - </refsection> - <refsection> - <title>Description</title> - <para>Do a sum.</para> - <para>Add here a paragraph of the function description </para> - <para> - LaTeX can also be used to render equation: In this case, the rendering should <latex>$x+y$</latex> - </para> - </refsection> - <refsection> - <title>Examples</title> - <programlisting role="example">scilab_sum(3,4)</programlisting> - </refsection> - <refsection role="see also"> - <title>See also</title> - <simplelist type="inline"> - <member> - <link linkend="c_sum">c_sum</link> - </member> - <member> - <link type="scilab" linkend="scilab.help/sum">Link to the Scilab help page</link> - </member> - </simplelist> - </refsection> -</refentry> diff --git a/jar/scilab_en_US_help.jar b/jar/scilab_en_US_help.jar Binary files differnew file mode 100644 index 0000000..8169a1d --- /dev/null +++ b/jar/scilab_en_US_help.jar @@ -1,5 +1,4 @@ <?xml version="1.0" encoding="UTF-8" standalone="no"?> -<scilablib name="scilab_toolboxlib"> - <macro name="scilab_error" file="scilab_error.bin" md5="1d8333160de4df7b257ac6ce6a660fb4"/> - <macro name="scilab_sum" file="scilab_sum.bin" md5="1ca685054fd3e9159204826fc4f3b06a"/> +<scilablib name="scilab_octavelib"> + <macro name="octave_fun" file="octave_fun.bin" md5="1648c1471394ed99be43b78ba3ee3576"/> </scilablib> diff --git a/macros/octave_fun.bin b/macros/octave_fun.bin Binary files differnew file mode 100644 index 0000000..b1ab402 --- /dev/null +++ b/macros/octave_fun.bin diff --git a/macros/octave_fun.sci b/macros/octave_fun.sci new file mode 100644 index 0000000..84b374d --- /dev/null +++ b/macros/octave_fun.sci @@ -0,0 +1,63 @@ +function [y] = octave_fun() + // Calls an octave function with given inputs and returns the expected output + // + // Syntax + // [y1, y2, ...] = octave_fun("octave_function",input1,input2,...) + // [y1, y2, ...] = octave_fun("octave_function",input1,input2,...,optional_input1,optional_input2,...) + // [y1, y2, ...] = octave_fun("octave_function","octave_package",input1,input2,...) + // [y1, y2, ...] = octave_fun("octave_function","octave_package",input1,input2,...,optional_input1,optional_input2,...) + // + // Parameters + // y : ouput as returned by octave. It can be a vector or matrix of doubles + // octave_function : name of the function in octave that has to be called. It has to be a string in double quotes + // input : input as expected by the octave function. It can be a vector or matrix of doubles + // optional_input : an optional argument that the given octave function can accept. It has to be a string in double quotes + // octave_package : name of the package in octave that has to be loaded as required by the octave function. It has to be a string in double quotes + // + // Description + // This function accepts an octave function name with the relevant inputs and returns the output as generated. It requires Octave to be installed along with necessary packages. + // + // <latex> + // \begin{eqnarray} + // &\mbox{min}_{x} + // & C^Tâ‹…x \\ + // & \text{subject to}& Aâ‹…x = b \\ + // & & Gâ‹…x \preceq_K h \\ + // & & x_i \in \{0,1\}, i \in \!\, bool_vars\ + // & & x_j \in \!\, \mathbb{Z}, i \in \!\, int_vars\\ + // \end{eqnarray} + // </latex> + // + // Examples + // // Finding the inverse of a matrix using octave + // A=[1 2 3;4 5 6;7 8 0] + // y = octave_fun("inv",A) + // y*A + // + // Examples + // + // // Finding the roots of a polynomial using its coefficients as inputs, using octave + // p = [1 2 3]; + // y = octave_fun("roots",p) + // + // Examples + // + // // Generating filter coefficients of a Hamming window of length M, using octave. + // M = 5 + // y = octave_fun("hamming",M) + // + // Examples + // + // // Generating filter coefficients of a Hamming window of length M with optional arguments, using octave. + // M = 5 + // y = octave_fun("hamming",M,"periodic") + // + // + // Examples + // + // // Generating an elliptic or Cauer filter with given passband ripple and stopband attenuation, using octave and its "signal" package. See help in octave for more information about "ellip" function + // [b, a]=octave_fun("ellip","signal",5,1,90,[0.1 0.2]) + // +// Authors +// Rupak Rokade +endfunction diff --git a/macros/scilab_error.bin b/macros/scilab_error.bin Binary files differdeleted file mode 100644 index 41c22ca..0000000 --- a/macros/scilab_error.bin +++ /dev/null diff --git a/macros/scilab_error.sci b/macros/scilab_error.sci deleted file mode 100644 index 24d1559..0000000 --- a/macros/scilab_error.sci +++ /dev/null @@ -1,19 +0,0 @@ -// ==================================================================== -// Template toolbox_skeleton -// This file is released under the 3-clause BSD license. See COPYING-BSD. -// ==================================================================== -// -// -function scilab_error(varargin) - - argSize = size(varargin); - - if argSize <> 1 then - error(msprintf(_("toolbox_skeleton", "%s: I''m waiting for only one argument.\n"), "scilab_error")); - end - - if argSize == 1 then - error(msprintf(gettext("toolbox_skeleton", "%s: Yeah! %d is a good number of arguments but I prefer fail, sorry.\n"), "scilab_error", 1)); - end -endfunction -// ==================================================================== diff --git a/macros/scilab_sum.bin b/macros/scilab_sum.bin Binary files differdeleted file mode 100644 index 925a0fc..0000000 --- a/macros/scilab_sum.bin +++ /dev/null diff --git a/macros/scilab_sum.sci b/macros/scilab_sum.sci deleted file mode 100644 index b9c5fa0..0000000 --- a/macros/scilab_sum.sci +++ /dev/null @@ -1,10 +0,0 @@ -// ==================================================================== -// Template toolbox_skeleton -// This file is released under the 3-clause BSD license. See COPYING-BSD. -// ==================================================================== -// -// -function s = scilab_sum(valA,valB) - s = valA + valB; -endfunction -// ==================================================================== diff --git a/sci_gateway/cpp/builder_gateway_cpp.sce b/sci_gateway/cpp/builder_gateway_cpp.sce index b39f612..f4747d1 100644 --- a/sci_gateway/cpp/builder_gateway_cpp.sce +++ b/sci_gateway/cpp/builder_gateway_cpp.sce @@ -12,7 +12,7 @@ mode(-1) lines(0) -toolbox_title = "scilab_toolbox"; +toolbox_title = "scilab_octave"; Build_64Bits = %t; @@ -26,7 +26,7 @@ Function_Names = [ //Name of all the files to be compiled Files = [ - "sci_matrix.cpp" + "sci_octave.cpp" ] diff --git a/sci_gateway/cpp/cleaner.sce b/sci_gateway/cpp/cleaner.sce index 74db4be..5e177af 100644 --- a/sci_gateway/cpp/cleaner.sce +++ b/sci_gateway/cpp/cleaner.sce @@ -10,20 +10,20 @@ if fileinfo('loader.sce') <> [] then mdelete('loader.sce'); end // ------------------------------------------------------ -if fileinfo('libscilab_toolbox.so') <> [] then - mdelete('libscilab_toolbox.so'); +if fileinfo('libscilab_octave.so') <> [] then + mdelete('libscilab_octave.so'); end // ------------------------------------------------------ -if fileinfo('libscilab_toolbox.cpp') <> [] then - mdelete('libscilab_toolbox.cpp'); +if fileinfo('libscilab_octave.cpp') <> [] then + mdelete('libscilab_octave.cpp'); end // ------------------------------------------------------ -if fileinfo('libscilab_toolbox.hxx') <> [] then - mdelete('libscilab_toolbox.hxx'); +if fileinfo('libscilab_octave.hxx') <> [] then + mdelete('libscilab_octave.hxx'); end // ------------------------------------------------------ -if fileinfo('libscilab_toolbox.h') <> [] then - mdelete('libscilab_toolbox.h'); +if fileinfo('libscilab_octave.h') <> [] then + mdelete('libscilab_octave.h'); end // ------------------------------------------------------ chdir(curdir); diff --git a/sci_gateway/cpp/libscilab_toolbox.cpp b/sci_gateway/cpp/libscilab_octave.cpp index 564874c..7cd692a 100644 --- a/sci_gateway/cpp/libscilab_toolbox.cpp +++ b/sci_gateway/cpp/libscilab_octave.cpp @@ -1,14 +1,14 @@ #include <wchar.h> -#include "libscilab_toolbox.hxx" +#include "libscilab_octave.hxx" extern "C" { -#include "libscilab_toolbox.h" +#include "libscilab_octave.h" #include "addfunction.h" } -#define MODULE_NAME L"libscilab_toolbox" +#define MODULE_NAME L"libscilab_octave" -int libscilab_toolbox(wchar_t* _pwstFuncName) +int libscilab_octave(wchar_t* _pwstFuncName) { if(wcscmp(_pwstFuncName, L"octave_fun") == 0){ addCFunction(L"octave_fun", &sci_octave_fun, MODULE_NAME); } diff --git a/sci_gateway/cpp/libscilab_octave.h b/sci_gateway/cpp/libscilab_octave.h new file mode 100644 index 0000000..16c5bc2 --- /dev/null +++ b/sci_gateway/cpp/libscilab_octave.h @@ -0,0 +1,8 @@ +#ifndef __LIBSCILAB_OCTAVE_GW_H__ +#define __LIBSCILAB_OCTAVE_GW_H__ + +#include "c_gateway_prototype.h" + +C_GATEWAY_PROTOTYPE(sci_octave_fun); + +#endif /* __LIBSCILAB_OCTAVE_GW_H__ */ diff --git a/sci_gateway/cpp/libscilab_octave.hxx b/sci_gateway/cpp/libscilab_octave.hxx new file mode 100644 index 0000000..416c8f8 --- /dev/null +++ b/sci_gateway/cpp/libscilab_octave.hxx @@ -0,0 +1,18 @@ +#ifndef __LIBSCILAB_OCTAVE_GW_HXX__ +#define __LIBSCILAB_OCTAVE_GW_HXX__ + +#ifdef _MSC_VER +#ifdef LIBSCILAB_OCTAVE_GW_EXPORTS +#define LIBSCILAB_OCTAVE_GW_IMPEXP __declspec(dllexport) +#else +#define LIBSCILAB_OCTAVE_GW_IMPEXP __declspec(dllimport) +#endif +#else +#define LIBSCILAB_OCTAVE_GW_IMPEXP +#endif + +extern "C" LIBSCILAB_OCTAVE_GW_IMPEXP int libscilab_octave(wchar_t* _pwstFuncName); + + + +#endif /* __LIBSCILAB_OCTAVE_GW_HXX__ */ diff --git a/sci_gateway/cpp/libscilab_toolbox.so b/sci_gateway/cpp/libscilab_octave.so Binary files differindex 1349c2f..32f1555 100755 --- a/sci_gateway/cpp/libscilab_toolbox.so +++ b/sci_gateway/cpp/libscilab_octave.so diff --git a/sci_gateway/cpp/libscilab_toolbox.h b/sci_gateway/cpp/libscilab_toolbox.h deleted file mode 100644 index 3035e8b..0000000 --- a/sci_gateway/cpp/libscilab_toolbox.h +++ /dev/null @@ -1,8 +0,0 @@ -#ifndef __LIBSCILAB_TOOLBOX_GW_H__ -#define __LIBSCILAB_TOOLBOX_GW_H__ - -#include "c_gateway_prototype.h" - -C_GATEWAY_PROTOTYPE(sci_octave_fun); - -#endif /* __LIBSCILAB_TOOLBOX_GW_H__ */ diff --git a/sci_gateway/cpp/libscilab_toolbox.hxx b/sci_gateway/cpp/libscilab_toolbox.hxx deleted file mode 100644 index a36a14c..0000000 --- a/sci_gateway/cpp/libscilab_toolbox.hxx +++ /dev/null @@ -1,18 +0,0 @@ -#ifndef __LIBSCILAB_TOOLBOX_GW_HXX__ -#define __LIBSCILAB_TOOLBOX_GW_HXX__ - -#ifdef _MSC_VER -#ifdef LIBSCILAB_TOOLBOX_GW_EXPORTS -#define LIBSCILAB_TOOLBOX_GW_IMPEXP __declspec(dllexport) -#else -#define LIBSCILAB_TOOLBOX_GW_IMPEXP __declspec(dllimport) -#endif -#else -#define LIBSCILAB_TOOLBOX_GW_IMPEXP -#endif - -extern "C" LIBSCILAB_TOOLBOX_GW_IMPEXP int libscilab_toolbox(wchar_t* _pwstFuncName); - - - -#endif /* __LIBSCILAB_TOOLBOX_GW_HXX__ */ diff --git a/sci_gateway/cpp/loader.sce b/sci_gateway/cpp/loader.sce index dd2e723..d9123cf 100644 --- a/sci_gateway/cpp/loader.sce +++ b/sci_gateway/cpp/loader.sce @@ -2,19 +2,19 @@ // Generated by builder.sce : Please, do not edit this file // ---------------------------------------------------------------------------- // -libscilab_toolbox_path = get_absolute_file_path('loader.sce'); +libscilab_octave_path = get_absolute_file_path('loader.sce'); // // ulink previous function with same name -[bOK, ilib] = c_link('libscilab_toolbox'); +[bOK, ilib] = c_link('libscilab_octave'); if bOK then ulink(ilib); end // list_functions = [ 'octave_fun'; ]; -addinter(libscilab_toolbox_path + filesep() + 'libscilab_toolbox' + getdynlibext(), 'libscilab_toolbox', list_functions); +addinter(libscilab_octave_path + filesep() + 'libscilab_octave' + getdynlibext(), 'libscilab_octave', list_functions); // remove temp. variables on stack -clear libscilab_toolbox_path; +clear libscilab_octave_path; clear bOK; clear ilib; clear list_functions; diff --git a/sci_gateway/cpp/result.txt b/sci_gateway/cpp/result.txt deleted file mode 100644 index 94c6830..0000000 --- a/sci_gateway/cpp/result.txt +++ /dev/null @@ -1,4 +0,0 @@ -00000000000f7820 g DF .text 0000000000000005 Base dfftw_set_timelimit__ -00000000000f6730 g DF .text 0000000000000009 Base dfftw_set_timelimit_ -00000000000f5ec0 g DF .text 000000000000000f Base fftw_set_planner_hooks -00000000000f98d0 g DF .text 0000000000000022 Base fftw_set_timelimit diff --git a/sci_gateway/cpp/sci_matrix.c b/sci_gateway/cpp/sci_matrix.c deleted file mode 100644 index cf217d6..0000000 --- a/sci_gateway/cpp/sci_matrix.c +++ /dev/null @@ -1,38 +0,0 @@ - -#include<Scierror.h> -#include<sciprint.h> -#include<api_scilab.h> -#include "localization.h" -#include "fun.h" -#include <stdio.h> -#include <math.h> - -static const char fname[] = "octave_fun"; - -int sci_octave_fun(scilabEnv env, int nin, scilabVar* in, int nopt, scilabOpt* opt, int nout, scilabVar* out) - -{ -double retval; -double* out1 = NULL; - -if (nin != 0) - { - Scierror(77, _("%s: Wrong number of input argument(s): %d expected.\n"), fname, 2); - return 1; - } - -if (nout != 1) - { - Scierror(77, _("%s: Wrong number of output argument(s): %d expected.\n"), fname, 1); - return 1; - } - *out = scilab_createDoubleMatrix2d(env, 1, 1, 5); - fun(&retval); - printf("%f\n", retval); - *out1 = retval; - scilab_getDoubleArray(env, out[0], &out1); - - - - return 0; -} diff --git a/sci_gateway/cpp/sci_matrix_bkup.cpp b/sci_gateway/cpp/sci_matrix_bkup.cpp deleted file mode 100644 index 071d330..0000000 --- a/sci_gateway/cpp/sci_matrix_bkup.cpp +++ /dev/null @@ -1,32 +0,0 @@ -extern "C" -{ -#include<Scierror.h> -#include<api_scilab.h> -#include "localization.h" -#include<fun.h> - -static const char fname[] = "octave_fun"; - -int sci_octave_fun(scilabEnv env, int nin, scilabVar* in, int nopt, scilabOpt* opt, int nout, scilabVar* out) - -{ - -if (nin != 0) - { - Scierror(77, _("%s: Wrong number of input argument(s): %d expected.\n"), fname, 2); - return 1; - } - -if (nout != 1) - { - Scierror(77, _("%s: Wrong number of output argument(s): %d expected.\n"), fname, 1); - return 1; - } - - double x = fun(); - - out[0] = scilab_createDouble( env, x); - - return 0; -} -} diff --git a/sci_gateway/cpp/sci_matrix_old.cpp b/sci_gateway/cpp/sci_matrix_old.cpp deleted file mode 100644 index fd45445..0000000 --- a/sci_gateway/cpp/sci_matrix_old.cpp +++ /dev/null @@ -1,52 +0,0 @@ -extern "C" -{ -#include<Scierror.h> -#include<api_scilab.h> -#include "localization.h" -#include<fun.h> - -static const char fname[] = "octave_fun"; - -int sci_octave_fun(scilabEnv env, int nin, scilabVar* in, int nopt, scilabOpt* opt, int nout, scilabVar* out) - -{ - int i = 0; - int row1 = 0; - int col1 = 0; - int size1 = 0; - double* in1 = NULL; - double* out1 = NULL; - - int row2 = 0; - int col2 = 0; - int size2 = 0; - double* in2 = NULL; - double* out2 = NULL; - - -if (nin != 0) - { - Scierror(77, _("%s: Wrong number of input argument(s): %d expected.\n"), fname, 2); - return 1; - } - -if (nout != 1) - { - Scierror(77, _("%s: Wrong number of output argument(s): %d expected.\n"), fname, 1); - return 1; - } - - out1 = fun(); - size1 = sizeof(out1)/sizeof(out1[0]); - - //Creating scilab matrix and saving in pointers out[0] and out[1] - out[0] = scilab_createDoubleMatrix2d(env, size1, 1, 0); - - //saving the output in out1 and out2 - scilab_getDoubleArray(env, out[0], &out1); - - - - return 0; -} -} diff --git a/sci_gateway/cpp/sci_matrix.cpp b/sci_gateway/cpp/sci_octave.cpp index 2346bdd..0e9c228 100644 --- a/sci_gateway/cpp/sci_matrix.cpp +++ b/sci_gateway/cpp/sci_octave.cpp @@ -22,9 +22,9 @@ int sci_octave_fun(scilabEnv env, int nin, scilabVar* in, int nopt, scilabOpt* o { //printf("nin: %d\n", nin); - if (nin < 1) + if (nin < 2) { - Scierror(999, _("%s: Wrong number of input arguments. Atleast %d expected.\n"), fname, 1); + Scierror(999, _("%s: Wrong number of input arguments. Atleast %d expected.\n"), fname, 2); return STATUS_ERROR; } |
