Scilab Online Help
5.3.0 - English

• Scilab Online Help
• Scilab
• Differential Equations, Integration
• Elementary Functions
• Linear Algebra
• Interpolation
• CACSD
• Polynomials
• Signal Processing
• FFTW
• Special Functions
• Randlib
• ARnoldi PACKage
• Statistics
• Sparses Matrix
• UMFPACK Interface
• Optimization and Simulation
• Genetic Algorithms
• Simulated Annealing
• Symbolic
• Files : Input/Output functions
• Input/Output functions
• Graphics Library
• Graphics : exporting and printing
• GUI
• Data Structures
• Parameters
• Boolean
• Integers
• Strings
• Sound file handling
• Time and Date
• Output functions
• xcos
• Spreadsheet
• Shell
• Console
• Completion
• History manager
• Matlab binary files I/O
• Matlab to Scilab Conversion Tips
• Compatibility Functions
• Maple Interface
• Overloading
• Functions
• Development tools
• Demo Tools
• Dynamic/incremental Link
• Atoms
• Tcl/Tk Interface
• Text editor
• UI Data
• Online help management
• Parallel
• PVM parallel Toolbox
• Modules manager
• Localization
• JVM
• API Scilab
• call_scilab API
• Java Interface
• Intersci

Please note that the recommended version of Scilab is 2025.0.0. This page might be outdated.
See the recommended documentation of this function

Scilab manual >> API Scilab

API Scilab

• 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.
  • booleanExample — Boolean use case.
• Boolean Sparse
  • isBooleanSparseType — Check if it is a boolean sparse variable.
  • getAllocatedBooleanSparseMatrix — Get sparse matrix attributs.
  • freeAllocatedBooleanSparse — Free memory allocated by getAllocatedBooleanSparseMatrix function.
  • booleanSparseExample — Boolean sparse use case.
• Scilab Gateway API
  • How to
    • CallingAScilabFunctionFromACInterface — Calling a scilab function (macros) from a C interface
    • HowToAccessAMatrix_1 — How to access a matrix using the C gateway functions
    • HowToCheckParameters — how to check parameter send to an interface using the C gateway functions
    • HowToCreateAndAccessAList_1 — How to create and access a list using the C gateway functions
    • HowToDealWithOptionalParameters — 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
  • ScilabCTypes — 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
• 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.
  • doubleExample — Double use case.
• integer
  • isIntegerType — Check if it is a double variable.
  • getScalarInteger8 — Get scalar integer variable.
  • createScalarInteger8 — Create scalar integer variable.
  • integerExample — Integer use case.
• List manipulation
  • 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_bsparse_reading_API — How to read boolean sparse in a list.
  • list_bsparse_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.
• Low level functions
  • boolean_reading_API — How to read matrix of boolean.
  • boolean_writing_API — How to write matrices of boolean.
  • bsparse_reading_API — How to read boolean sparse in a gateway.
  • bsparse_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.
  • int_getmatrixofintegerprecision_API — How to get precision of an integer matrix.
  • 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.
  • 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 matric 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.
• polynom
  • isPolyType — Check if it is a polynom variable.
  • getAllocatedSinglePoly — Get single polynom variable.
  • getAllocatedSingleComplexPoly — 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.
  • freeAllocatedMatrixOfPoly — Free memory allocated by getAllocatedSinglePoly function.
  • freeAllocatedMatrixOfComplexPoly — Free memory allocated by getAllocatedSinglePoly function.
  • polyExample — Polynom use case.
• 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.
  • sparseExample — Sparse use case.
• 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.
  • stringExample — String use case.
• api_scilab — api_scilab is the Scilab interface to read/write data from/to Scilab memory

<< JVM

Scilab manual

call_scilab API >>

---