Partie LIX. API Scilab

Table des matières

13. boolean
isBooleanType — Check if it is a boolean variable.
getScalarBoolean — Read scalar boolean data from a gateway argument.
createScalarBoolean — Create scalar boolean variable in Scilab memory.
boolean example — Boolean use case.
14. Boolean Sparse
isBooleanSparseType — Check if it is a boolean sparse variable.
getAllocatedBooleanSparseMatrix — Get sparse matrix attributs.
freeAllocatedBooleanSparse — Free memory allocated by getAllocatedBooleanSparseMatrix function.
boolean sparse example — Boolean sparse use case.
15. Scilab Gateway API
1. How to
Calling a scilab function (macros) from a C gateway — Calling a scilab function (macros) from a C interface
How to access a matrix — How to access a matrix using the C gateway functions
How to check parameters — how to check parameter send to an interface using the C gateway functions
How to create and access a list — How to create and access a list using the C gateway functions
How to deal with optional parameters — how to deal with optional parameters send to an interface using the C gateway functions
CheckColumn — C interface function which checks if a parameter send to the C function is a column vector or not
CheckDimProp — C interface function which checks the comatibility between 2 arguments send to the C function
CheckDims — C interface function which checks if a parameter send to the C function has the required dimensions
CheckLength — C interface function which checks the length of a vector send as a parameter to the C function
CheckLhs — C macro which checks the number of output arguments present in the calling Scilab function.
CheckRhs — C macro which checks the number of input arguments present in the calling Scilab function.
CheckRow — C interface function which checks if a parameter send to the C function is a row vector or not
CheckSameDims — C interface function which checks if two parameters send to the C function have the same size
CheckScalar — C interface function which checks if a parameter send to the C function is a scalar or not
CheckSquare — C interface function which checks if a parameter send to the C function is a square matrix or not
CheckVector — C interface function which checks if a parameter send to the C function is a vector (column or row) or not
CreateListVarFrom — a C interface function which allows to create a new Scilab parameter in a [mt]list
CreateListVarFromPtr — a C interface function which allows to create a new Scilab parameter from a pointer in a [mt]list
CreateVar — a C gateway function which allows to create a new Scilab parameter
FindOpt — C gateway function find the position of an optional argument given its name
FirstOpt — C gateway function which returns the position of the first optional parameter
GetListRhsVar — a C gateway function which allows to access a parameter stored in a [mt]list transmitted to a Scilab function
GetRhsVar — a C gateway function which allows to access an argument transmitted to a Scilab function
GetType — C gateway function which returns the type of a parameter in the Scilab memory
IsOpt — C gateway function which checks if a parameter is optional and returns the name of the parameter
Lhs — A C gateway function which provides the number of output arguments present in the calling Scilab function
LhsVar — a C gateway function which specifies which parameters created inside the C gateway will be returned as an output argument into Scilab.
NumOpt — C gateway function which returns the number of optional parameters sent to a C function
OverLoad — C gateway function which tells Scilab to look for another overloaded function
Rhs — A C gateway function which provides the number of input arguments present in the calling Scilab function
Scierror — C gateway function which displays an error message to the user (same profil as the printf function) and returns an integer value specifying an error level
Scilab C Types — the C types available in a C gateway
get_optionals — C gateway function which initialize the list of optional parameters
istk — Return a pointer to an integer to access data stored at a given position in the Scilab memory
sci_types — a C enumeration which defines the types available for a variable
sciprint — A C gateway function which displays standard messages to the user (same profil as the C printf function)
stk — Return a pointer to a double to access data stored at a given position in the Scilab memory
16. double
isDoubleType — Check if it is a double variable.
getScalarDouble — Get scalar double variable.
getScalarComplexDouble — Get scalar complex double variable.
createScalarDouble — Create a scalar double in Scilab memory.
createScalarComplexDouble — Create a scalar complex double in Scilab memory.
double example — Double use case.
17. integer
isIntegerType — Check if it is a double variable.
getScalarInteger8 — Get scalar integer variable.
createScalarInteger8 — Create scalar integer variable.
integer example — Integer use case.
18. List manipulation
Boolean reading (Scilab gateway) — How to read matrix of boolean in a list.
Boolean writing (Scilab gateway) — How to add matrix of boolean in a list.
Boolean sparse reading (Scilab gateway) — How to read boolean sparse in a list.
Boolean sparse writing (Scilab gateway) — How to add boolean sparse matrix in a list.
Create List (Scilab gateway) — How to get create a list in Scilab memory.
Double reading (Scilab gateway) — How to read matrix of double in a list.
Double writing (Scilab gateway) — How to add matrix of double in a list.
Get child item (Scilab gateway) — How to get the address of a list child.
Item Number (Scilab gateway) — How to get the number of items in a list (list, mlist, tlist).
Integer reading (Scilab gateway) — How to read matrix of integer in a list.
Integer writing (Scilab gateway) — How to add matrix of integer in a list.
Pointer reading (Scilab gateway) — How to read pointer in a list.
Pointer writing (Scilab gateway) — How to add pointer in a list.
Polynomial reading (Scilab gateway) — How to read matrix of polynomial in a list.
Polynomial writing (Scilab gateway) — How to add matrix of polynomial in a list.
Sparse reading (Scilab gateway) — How to read sparse in a list.
Sparse writing (Scilab gateway) — How to add sparse matrix in a list.
String reading (Scilab gateway) — How to read matrix of string in a list.
String writing (Scilab gateway) — How to add matrix of string in a list.
19. Low level functions
Boolean reading (Scilab gateway) — How to read matrix of boolean.
Boolean writing (Scilab gateway) — How to write matrices of boolean.
Boolean sparse reading (Scilab gateway) — How to read boolean sparse in a gateway.
Boolean sparse writing (Scilab gateway) — How to add boolean sparse matrix in a gateway.
Variable Reference (Scilab gateway) — How to get the address of an argument or a variable in a gateway.
Variable dimension (Scilab gateway) — How to get the dimensions of an argument or a variable stored as matrix.
Variable Type (Scilab gateway) — How to get the type of an argument or a variable within a gateway.
Variable Complexity (Scilab gateway) — How to get the argument or variable complexity.
Matrix Type (Scilab gateway) — How to know if an argument or a variable is stored as a matrix.
Double reading (Scilab gateway) — How to read matrices of double in a gateway.
Double writing (Scilab gateway) — How to write matrices of doubles in a gateway.
Integer Precision (Scilab gateway) — How to get precision of an integer matrix.
Integer reading (Scilab gateway) — How to read matrices of integer in a gateway.
Integer writing (Scilab gateway) — How to write matrices of integers in a gateway.
Pointer reading (Scilab gateway) — How to read pointer in a gateway.
Pointer writing (Scilab gateway) — How to write pointer in a gateway.
Polynomial Symbolic Variable (Scilab gateway) — How to get the symbolic variable name.
Polynomial reading (Scilab gateway) — How to read matrices of polynomials in a gateway.
Polynomial writing (Scilab gateway) — How to write matrices of polynomials in a gateway.
Sparse matrix reading (Scilab gateway) — How to read sparse matric in a gateway.
Sparse writing (Scilab gateway) — How to write sparse matrix in a gateway.
String reading (Scilab gateway) — How to read matrices of strings in a gateway.
String writing (Scilab gateway) — How to write matrices of string in a gateway.
20. polynom
isPolyType — Check if it is a polynom variable.
getAllocatedSinglePoly — Get single polynom variable.
getAllocatedSinglePoly — Get single complex polynom variable.
getAllocatedMatrixOfPoly — Get matrix of polynom variable.
getAllocatedMatrixOfComplexPoly — Get matrix of complex polynom variable.
freeAllocatedSinglePoly — Free memory allocated by getAllocatedSinglePoly function.
freeAllocatedSingleComplexPoly — Free memory allocated by getAllocatedSingleComplexPoly function.
freeAllocatedSinglePoly — Free memory allocated by getAllocatedSinglePoly function.
freeAllocatedSinglePoly — Free memory allocated by getAllocatedSinglePoly function.
polynom example — Polynom use case.
21. sparse
isSparseType — Check if it is a sparse variable.
getAllocatedSparseMatrix — Get sparse matrix variable.
getAllocatedComplexSparseMatrix — Get complex sparse matrix variable.
freeAllocatedSparseMatrix — Free memory allocated by getAllocatedSparseMatrix function.
freeAllocatedComplexSparseMatrix — Free memory allocated by getAllocatedComplexSparseMatrix function.
sparse example — Sparse use case.
22. string
isStringType — Check if it is a string variable.
getAllocatedSingleString — Get single string variable.
getAllocatedMatrixOfString — Get matrix of polynom variable.
createSingleString — create a single string variable.
freeAllocatedSingleString — Free memory allocated by getAllocatedSinglePoly function.
freeAllocatedMatrixOfString — Free memory allocated by freeAllocatedMatrixOfString function.
string example — String use case.
api_scilab — api_scilab is the Scilab interface to read/write data from/to Scilab memory