Please note that the recommended version of Scilab is 2024.1.0. This page might be outdated.
However, this page did not exist in the previous stable version.
api_scilab
api_scilab is the Scilab interface to read/write data from/to Scilab memory
Description
Since Scilab 5.2.0, Scilab provides a consistent, documented and easy way API.
This API provides functions to read/write data from/to Scilab memory.
It provides many advantages:
Management of all Scilab data types
Consistency over all data types
Error management
Fully documented
Fully tested by unitary tests
Straight and named access (See the call_scilab API) to variables.
And it will be maintained over future versions of Scilab
Usually, this API is used to extend Scilab capabilities but can be used in other contexts
Libraries or C/C++ functions: Many libraries have been developed 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.
Scilab can be used as computing engine from a third party software. This feature is called call_scilab when Scilab is used from C/C++ code or javasci when used from Java. Access to variable is done through their names (named variable).
Note that old APIs (stackX.h) will not be available after Scilab 6.0 (included).
History
Version | Description |
5.4.0 | Add some functions/macros in replacement of stack functions/macros
Add functions to identify list datatypes:
|
5.5.0 | Add functions to manage handles
|
See also - API_Scilab
- boolean reading API — How to read matrix of boolean.
- boolean writing API — How to write matrices of boolean.
- boolean sparse reading API — How to read boolean sparse in a gateway.
- boolean sparse writing API — How to add boolean sparse matrix in a gateway.
- Common getvaraddr API — How to get the address of an argument or a variable in a gateway.
- Common getvardimension API — How to get the dimensions of an argument or a variable stored as matrix.
- Common getvartype API — How to get the type of an argument or a variable within a gateway.
- Common iscomplex API — How to get the argument or variable complexity.
- Common isvarmatrixtype API — How to know if an argument or a variable is stored as a matrix.
- Double management reading API — How to read matrices of double in a gateway.
- Double management writing API — How to write matrices of doubles in a gateway.
- Integer management reading API — How to read matrices of integer in a gateway.
- Integer management writing API — How to write matrices of integers in a gateway.
- getmatrixofintegerprecision API — How to get precision of an integer matrix.
- Pointer reading API — How to read pointer in a gateway.
- Pointer writing API — How to write pointer in a gateway.
- poly getpolyvariablename API — How to get the symbolic variable name.
- Polynomial management reading API — How to read matrices of polynomials in a gateway.
- Polynomial management writing API — How to write matrices of polynomials in a gateway.
- Sparse management reading API — How to read sparse matrices in a gateway.
- Sparse management writing_API — How to write sparse matrix in a gateway.
- String management reading API — How to read matrices of strings in a gateway.
- String management writing API — How to write matrices of string in a gateway.
- handle reading API — How to read matrix of handle.
- handle writing API — How to write matrices of handle.
See also - API_Scilab list management
- list boolean reading API — How to read matrix of boolean in a list.
- list boolean writing API — How to add matrix of boolean in a list.
- list boolean sparse reading API — How to read boolean sparse in a list.
- list boolean sparse writing API — How to add boolean sparse matrix in a list.
- list_createlist API — How to get create a list in Scilab memory.
- list double reading API — How to read matrix of double in a list.
- list double writing API — How to add matrix of double in a list.
- list getlistitemaddress API — How to get the address of a list child.
- list getlistitemnumber API — How to get the number of items in a list (list, mlist, tlist).
- list integer reading API — How to read matrix of integer in a list.
- list integer writing API — How to add matrix of integer in a list.
- list pointer reading API — How to read pointer in a list.
- list pointer writing API — How to add pointer in a list.
- list poly reading API — How to read matrix of polynomial in a list.
- list poly writing API — How to add matrix of polynomial in a list.
- list sparse reading API — How to read sparse in a list.
- list sparse writing API — How to add sparse matrix in a list.
- list string reading API — How to read matrix of string in a list.
- list string writing API — How to add matrix of string in a list.
See also - call_scilab
- Call_Scilab — call_scilab is an interface which provides the ability to call Scilab engine from C/C++ code
- Compile and run with call_scilab — How to compile a native application based on or using Scilab
- Matrix Management — How to manage Scilab's variable read and write process using call_scilab and api_scilab
- Boolean Management — How to manage Scilab's boolean read and write process using call_scilab and api_scilab
- Complex Management — How to manage Scilab's complex variable read and write process using call_scilab
- String Management — How to manage Scilab's String read and write process using call_scilab and api_scilab
Report an issue | ||
<< string | legacy | API Scilab >> |