summaryrefslogtreecommitdiffstats
path: root/scilab/modules/api_scilab
diff options
context:
space:
mode:
authorSylvestre Ledru <sylvestre.ledru@scilab.org>2010-01-20 17:21:35 +0100
committerSylvestre Ledru <sylvestre.ledru@scilab.org>2010-01-20 17:21:35 +0100
commit4f9fbe79a4b0585860e44115787c04b225a6050e (patch)
tree1c1482cdd81d874211709d5625625e012ab204a6 /scilab/modules/api_scilab
parent5b4107b019e3abfe0dee94d8e6d5af786c92c974 (diff)
downloadscilab-4f9fbe79a4b0585860e44115787c04b225a6050e.zip
scilab-4f9fbe79a4b0585860e44115787c04b225a6050e.tar.gz
Description page of what is API_Scilab
Diffstat (limited to 'scilab/modules/api_scilab')
-rw-r--r--scilab/modules/api_scilab/help/en_US/api_scilab.xml89
1 files changed, 89 insertions, 0 deletions
diff --git a/scilab/modules/api_scilab/help/en_US/api_scilab.xml b/scilab/modules/api_scilab/help/en_US/api_scilab.xml
new file mode 100644
index 0000000..57a85d9
--- /dev/null
+++ b/scilab/modules/api_scilab/help/en_US/api_scilab.xml
@@ -0,0 +1,89 @@
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4 * Copyright (C) 2010 - DIGITEO - Sylvestre LEDRU
5 *
6 * This file must be used under the terms of the CeCILL.
7 * This source file is licensed as described in the file COPYING, which
8 * you should have received as part of this distribution. The terms
9 * are also available at
10 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11 *
12 -->
13<refentry version="5.0-subset Scilab" xml:id="api_scilab" xml:lang="en"
14 xmlns="http://docbook.org/ns/docbook"
15 xmlns:xlink="http://www.w3.org/1999/xlink"
16 xmlns:svg="http://www.w3.org/2000/svg"
17 xmlns:ns5="http://www.w3.org/1999/xhtml"
18 xmlns:mml="http://www.w3.org/1998/Math/MathML"
19 xmlns:db="http://docbook.org/ns/docbook">
20 <info>
21 <pubdate>$LastChangedDate$</pubdate>
22 </info>
23
24 <refnamediv>
25 <refname>api_scilab</refname>
26
27 <refpurpose>api_scilab is the Scilab interface to read/write data from/to Scilab memory </refpurpose>
28 </refnamediv>
29
30 <refsection>
31 <title>Description</title>
32
33 <para>In the previous versions of Scilab, there was no clear or easy way to extend Scilab or to use it as an embedded application.</para>
34<para>Since Scilab 5.2.0, these issues have been tackled by API Scilab. Its provides a new consistent, documented and easy way API.
35</para>
36
37 <para>This API provides functions to read/write data from/to Scilab memory.</para>
38<para> It provides many advantages:</para>
39 <itemizedlist>
40 <listitem>
41<para>Management of all Scilab data types</para></listitem>
42<listitem>
43<para>Consistency over all data types</para></listitem>
44<listitem>
45<para>Error management</para></listitem>
46<listitem>
47<para>Fully documented</para></listitem>
48<listitem>
49<para>Fully tested by unitary tests</para></listitem>
50<listitem>
51<para>Straight and named access (See the <link linkend="call_scilab">call_scilab API</link>) to variables.</para></listitem>
52<listitem>
53<para>And it will be maintained over future versions of Scilab</para></listitem>
54</itemizedlist>
55
56<para>Usually, this API is used to extend Scilab capabilities but can be used in other contexts</para>
57
58 <itemizedlist>
59 <listitem>
60<para>Libraires or C/C++ functions: Many librairies have been developped on the free/Open source or proprietary markets. This library can be loaded and used in a high level language like Scilab. API Scilab provides the capabilities to interact with such libraries.
61</para>
62 </listitem>
63 <listitem>
64<para>Scilab can be used as computing engine from a third party software. This feature is called <link linkend="call_scilab">call_scilab</link> when Scilab is used from C/C++ code or <link linkend="javasci">javasci</link> when used from Java. Access to variable is done through their names (named variable).
65</para>
66 </listitem>
67</itemizedlist>
68 <para>Note that old APIs (stackX.h) will not be available after Scilab 6.0 (included).</para>
69 </refsection>
70
71 <refsection>
72 <title>See Also</title>
73
74 <simplelist type="inline">
75 <member><link linkend="compile_and_run_call_scilab">Compile and run with
76 call_scilab</link>, <link linkend="DoubleManagement_callscilab">Matrix
77 Management</link>, <link linkend="BooleanManagement_callscilab">Boolean
78 Management</link>, <link linkend="ComplexManagement_callscilab">Complex
79 Management</link>, <link linkend="StringManagement_callscilab">String
80 Management</link>, <link linkend="call_scilab">Call_Scilab</link></member>
81 </simplelist>
82 </refsection>
83
84 <refsection>
85 <title>Authors</title>
86
87 <para>Sylvestre Ledru</para>
88 </refsection>
89</refentry>