loadlibrary — Load a native C shared library and prepare its declared header interface.
loadlibrary(library, header) prepares the header declarations and loads the matching shared library into the current session. With one argument, the header path is inferred by replacing the library extension with .h. [notfound, warnings] returns unprepared declarations and preparation warnings; a statement call suppresses the report.
Syntax
[notfound, warnings] = loadlibrary(library, [header], [name, value]...)Inputs
library- Type
Any- Required
- Yes
- Default
- —
- Description
- Scalar text, number, or logical library path or name.
header- Type
Any- Required
- No
- Default
library path with .h extension- Description
- Optional scalar text, number, or logical header path.
optionName- Type
Any- Required
- Variadic
- Default
- —
- Description
- Alias, IncludePath, or AddHeader followed by a scalar text-coercible value.
Returns
notfound- Type
Any- Description
- One-row cell array of unprepared declarations.
warnings- Type
Any- Description
- Preparation warning string.
Returned values from loadlibrary depend on how many outputs the caller requests.
Errors
RunMat:Foreign:UnsupportedOnWasm- When
- The current host cannot load a native shared library.
- Message
Native shared libraries are unavailable on this host.
RunMat:Foreign:InvalidCall- When
- Arguments do not satisfy the normalized shared-library contract.
- Message
Invalid shared-library operation.
RunMat:Foreign:HostUnavailable- When
- A native shared-library operation is invoked without an active runtime context.
- Message
Native shared-library operation has no active runtime context.
Options
Alias selects the session library name. IncludePath supplies additional header search paths; AddHeader includes another declaration header. Options are name-value pairs and are parsed before invoking the native adapter.
Native host
Requires a native host, a compatible C compiler/header frontend, the shared library, and the exact prepared interface artifact. Browser execution reports RunMat:Foreign:UnsupportedOnWasm; the process-local foreign adapter owns loaded symbols and pointer leases.
Example
Load the prepared C fixture
[notfound, warnings] = loadlibrary('fixture', 'fixture.h', 'Alias', 'fixture');
assert(iscell(notfound));
assert(ischar(warnings) || isstring(warnings));
assert(libisloaded('fixture'));
unloadlibrary('fixture');Using loadlibrary with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how loadlibrary changes the result.
Run a small loadlibrary example, explain the result, then change one input and compare the output.
FAQ
Is a header sufficient to load a library?⌄
No. The matching native library and its declared interface must both be available; symbols are validated against the prepared manifest.
Related Interop functions
Native
calllib · clibgen.buildInterface · libfunctions · libisloaded · libpointer · libstruct · setdatatype · unloadlibrary
Java
isjava · javaaddpath · javaArray · javaclasspath · javaMethod · javaMethodEDT · javaObject · javaObjectEDT · javarmpath · jenv · usejava
Source you can read
Every RunMat function's source is public. Read exactly how loadlibrary is executed, line by line, in Rust.
- View the source for loadlibrary in Rust on GitHub
- Learn how the RunMat runtime works
- Found a bug? Open an issue with a minimal reproduction.
About RunMat
RunMat is a runtime that executes MATLAB-syntax code fast on any GPU. The runtime is free for individuals, including freelancers; students and faculty at an academic institution, for teaching or research there; contributors to an open-source project, for work on that project; organizations with 250 or fewer people and US$10M or less in annual revenue; and anyone, for non-production use. See runmat.com/license.
- RunMat automatically optimizes your math for GPU execution on Apple, Nvidia, and AMD hardware. No code changes needed. Simulations that took hours now take minutes.
- Start running code in seconds. RunMat runs in the browser, on the desktop, or from the CLI. No license server, no IT ticket.