Qlua Reference Manual
Every user-accessible function of the Qlua interpreter, organized by the data type it belongs to and, for the Level III solvers, by solver.
Qlua is Lua 5.1 with lattice QCD built in: the QDP/C field types and their algebra, the QIO and legacy file formats, and a set of Level III inverters. The tutorials on the Documentation page teach the language by example. This manual is the other half — the reference they promise: it lists what exists, what it takes and what it gives back.
Each entry names a function or a method, gives its call shape, and says what it returns. Where behavior is easier shown than described, a short example follows. Names that are registered but not reachable in a stock build — behind a #if 0, or behind a configuration option this build does not set — are collected in Optional back ends and in the notes that mention them, rather than being mixed in with what works.
The surface described here was read out of a running interpreter as well as out of the sources, so the two agree: every name below is one qlua will answer to.
This manual describes qlua/2026.10d and later. Against an older build some of it is simply wrong — several methods described here do not exist before 2026.10d, and calling a name a qlua object does not know raises rather than returning nil, so the failure is an aborted job rather than a nil. Which build this describes says exactly what changed and when.
|
