Please note that the recommended version of Scilab is 2023.1.0. This page might be outdated.
See the recommended documentation of this function
Returns the name of the loaded library/module a given function belongs to
libmod = whereis(function)
Name (text) or handle of a Scilab "macro" or builtin function. Both kinds of input are equivalent.
- a function written in Scilab language and registered with
genlib in some loaded library:
libmodreturns the name of the library.
- an unregistered user-defined function written in Scilab language:
- a builtin function (so-called Scilab primitive): the name of the
functionbelongs to is returned.
- a function written in Scilab language and registered with genlib in some loaded library:
whereis allows to identify the library of Scilab macros or the
module a given function belongs to.
When the function is
- a "macro" (written in Scilab language and compiled):
it may be not loaded (not yet called), but its library must be so.
When the same function name is registered in several loaded libraries of macros,
whereisreturns the name of all of them.
libraryinfo(..) allows to retrieve the path to definition files of a library.
- Since Scilab 6.0: When, in the mymacro.sci file defining a public
macro mymacro() registered in a library, some additional functions
are defined after mymacro(), these additional functions are NOT
registered in the library.
whereisignores them and will return
for them. See the Examples section.
- When a module like
xcoshas sublibraries, these ones are often loaded in Scilab only after the first call to the main function (like
xcos()). As a consequence,
whereis(..)querried for a function of such a sublibrary will return
, until the main function -- like
xcos()-- is called a first time. See the Examples section.
- Since Scilab 6.0: When, in the mymacro.sci file defining a public macro mymacro() registered in a library, some additional functions are defined after mymacro(), these additional functions are NOT registered in the library. So,
- a user-defined function registered in no library
- directly in the console by
function ... endfunction, or
- in a file loaded in the Scilab session with
"script". When this function is defined in a file, there is no way to retrieve the file path and name.
- directly in the console by
- a builtin written and compiled in an external language (C, C++..):
whereisreturns the name of the module the function belongs to.
The gateway file where the builtin function is declared to belong to the module is located at
moduleNamemust be replaced with the actual module name.
In the case that the function name is simultaneously defined as a unregistered function ("script"), and as a registered one in a library and as a builtin,
// Case of an unregistered macro: function myTest(), disp("Unregistered function"), endfunction whereis myTest // => "script" // Case of a registered macro: r = whereis("ls") // => "fileiolib" [?,path]= libraryinfo(r); path // => "SCI\modules\fileio\macros\" // Let's define another ls() in another library: path = TMPDIR+"/myls"; mkdir(path); mputl("function ls(), disp(""my other ls() in lslib""), endfunction", path+"/ls.sci"); genlib("lslib", path); whereis ls // => ["fileiolib"; "lslib"] // Case of a builtin function whereis sin // => "elementary_functions" whereis conv2 // => "signal_processing" // Case of an unregistered macro defined/loaded after a registered one: clear ls lslib whereis ls // "fileiolib" : OK function ls(), disp("my local ls()"), endfunction ls // => "my local ls()" whereis ls // => "fileiolib", still clear ls // (cleaning up) // Dependencies are ignored: // chfact() has some private dependency functions blkfc1(), inpnv(), etc: edit chfact // chfact() is registered: whereis chfact // => "sparselib" // .. but not its dependencies: whereis blkfc1 // =>  // Sublibraries may be loaded only after the first call to a main driving function: // CLR() is a public function related to the CLR Xcos block belonging to the // Linear palette and declared in the Linearlib library. // But this sublibrary is loaded only after a first call to xcos(): whereis xcos // => "xcoslib" whereis CLR // => , if you never called xcos() in the session yet. xcos() // => loads all its sublibraries. Please ignore the interfaces. // You may even close them. whereis CLR // => "Linearlib" non-empty answer, now
- genlib — build library from functions in given directory
- libraryinfo — get macros and path of a scilab library
- lib — loads a library of Scilab functions and variables, and sets its name
- getmodules — returns list of modules installed in Scilab
|Report an issue|
|<< varargout||Advanced functions||Testing & benchmarking >>|