Appendix: Qlua libraries name by name

Every global the shipped Lua libraries define, with its arguments, module by module.

The subsections are those of Libraries and then of The LHPC library, in the order those sections take them, so that a name found here can be read about where it was described.

A name printed as a link has an entry of its own earlier in this manual, and the link goes to it. A name printed plainly does not: its definition is the Lua source of the module the table belongs to, under the installed library directory, and that source is the place to read what it means. The list exists so that a name met in a script can be traced to the module that defines it, and so that the index covers these names too.

A name defined in more than one module is listed under the first one that defines it. Methods of the objects these modules build — the op: and solver: families in krylov, say — are left out: they are part of an object's protocol rather than globals.

Names in stdlib

NameArguments
printffmt, ...
eprintffmt, ...
intervallo, hi
skipexcl, ...
xml.getx, n, ...
rangelo, hi, step
basenamestr
dirnamestr
space2fullc, t_axis, c_t
full2spacecfull, t_axis
calc_avg_varf
list...
list_copysrc
list_appendres, x
list_extendres, t
list_slicetab, klist
list_islicetab, i0,i1,istep
list_mapfunc, list
list_equala,b
list_indexclist, cx
list_join...
list_tostringtab, fmt, sep
list_scala, v
list_reshape2dl, s12
list_padl, n, a
is_zerov
is_nonzerov
list_alll, f
list_anyl, f
table_elemi
table_countt
table_copytab, level
table_equala, b, skip_nil
table_indexclist, cx
table_updatedst, t
table_deepupdatedst, t
table_merge...
table_deepmerge...
table_delete_keyst, klist
table_tostringtab, fmt, sep
table_setdefaultt, k, v
table_assert_constls, v0, msg
table_assert_typels, tp, msg
string_is_prefixa, b
string_del_prefixa, b
string_is_postfixa, b
string_del_postfixa, b
string_splitstr, sep
bitwise_andx, y
bitwise_orx, y
ceil_multiplex, intx

Names in iter

NameArguments
iter.irepeatn, ...
iter.icycle...
iter.vrepeatn, ...
iter.counti0, di
iter.rangei, n, di
iter.ienumerate...
iter.imapmapfunc, ...
iter.ichopn, ...
iter.ichop_padn, l
iter.ichain...
iter.ifirstn, ...
iter.lproduct_rlex...
iter.lproduct_lex...
iter.tproductt
iter.litemsl
iter.igen_list...
iter.ichop_listn, ...
iter.lchopn, l
iter.lchop_listn, l
iter.lchop_padn, l
iter.imap_listf, ...
iter.lmapf, l
iter.lmap_listf, l
iter.imap_batchnbatch, fbatch, ...
iter.ordered_titemst, keysort_func
iter.ordered_tmap_tablef, t, keysort_func
iter.ordered_tmap_pair_tablef, t, keysort_func
iter.titemsf, t
iter.tmap_tablef, t
iter.tmap_pair_tablef, t

Names in set

NameArguments
set_adds, key
set_removes, key
set_containss, key
set_prints
set_lists
set_fromtablet
list_uniql

Names in pprint

NameArguments
index_strlenn, nmax
index_strfmtn, nmax
list_concat_multilinelist, sep, per_line
print_vector_alignedvec, fmt, sep, val_per_line, title
print_vectorvec, title
print_matrix_alignedmat, fmt, sep, val_per_line, title
print_matrixmat, title
print_cmatrixmat, title, flags
matrix_vdota, b
matrix_nrma
matrix_rdiffa, b
nargx
nabsx
print_cmatrix_cmpa, b, title

Names in verbose

NameArguments
print_network_settings—
print_subgrid_settingsL
print_objt, name, opt
print_typex, tit
spprint_tablet, indent, level, spprint_elem
print_mem_usage_shortmsg
func_info_fmtd
call_info_fmtd
print_warn...
depr_warnfunc, opt
timeitfunc, opt
timeit_reportopt
test_statusname
table_opt_extrat, kl
warn_opt_extrat, kl

Names in rcparam

NameArguments
contract_backend—
rcparams.getk
rcparams.setk, v

Names in test_fields

NameArguments
vec_constlt, x
vec_polylt, coeff
vec_explt, e
vec_cexplt, e
vec_sinlt, e
vec_coslt, e
vec_axpya,x,y
vec_scala,x
vec_symm_cyclicvec, t0
vec_shift_cyclicvec, dt
vec_gevmg_list, vec_list
vec_mulx,y
vec_mul_latx, l, t_axis
latI_linL, axis, x0
latI_rlinL, axis, x0
latI_distL, axis, x0
latR_linL, axis, x0
latR_rlinL, axis, x0
latR_distL, axis, x0
lat_polyx, coeff
make_latcolvec_pw_c_tL, t_axis, p3, src0, col
make_latcolvec_list_pw_c_exptL, t_axis, pw3_list, pw_x0, col_list, dep_pw3, dep_col
make_latdirprop_lin_pwL, lc5, ft_mom, ft_x0
make_4latdirferm_tv, t_axis, pw3, pw_x0, dep_spin

Names in quda

NameArguments
qcd.quda.initL
qcd.quda.fini—
qcd.quda.inverter.simpleU, gpx, ipx, opt
qcd.quda.inverter.multigridU, gpx, ipx, mpx, imx, opt

Names in gauge fields

gauge

NameArguments
gauge_topcharge_naiveU
naive_qU
toSUnX
gauge_transform_Ug, U
gauge_transform_U_dirg, U, mu
gauge_transform_Dg, F
gauge_transform_Pg, P
gauge_copyg
gauge_apply_boundaryg, bc
gauge_plaquetteU,i,j
plaquetteU,i,j
gauge_plaquette_allU
plaquette_allU
gauge_u1_plaquetteU,i,j
gauge_u1_plaquette_allU
gauge_clovsum_plaqU, i, j
gauge_cloverU, i, j
gauge_clovsum_rectU, i, j
clover_termU, i, j
gauge_clover_allU
clover_term_allU
gauge_u1_cloverU, i, j
gauge_u1_clover_allU
gauge_u1_const_fieldL, nflux_munu
gauge_u1_const_field_munuL, nflux, mu, nu
gauge_add_bgelectricgauge_u, efield, t_axis
gauge_add_bgmagneticgauge_u, hfield, t_axis
gauge_add_bgemgauge_u, bgem, t_axis

Names in smearing

ape-smear

NameArguments
APE_smearU, A, N, accu, imax, axis

hex-smear

NameArguments
gauge_hyp_generalU, nsteps, alpha, fatlink_sun_func
gauge_hex_smearU, n, alpha
gauge_hex_smear_bmwU, n
gauge_hyp_smearU, n, alpha, blk_accu, blk_maxiter
gauge_hyp_smear_stdU, n

stout-smear

NameArguments
get_stapleU, mu, numax
stout_smear_3dU, rho, n
get_staple_dirsetU, mu, dirset
stout_smear_fullU, rho, n, mu_skip

wuppertal-smear

NameArguments
wuppertal_smear_oldU, alpha, N, G, axis
wuppertal_smear_stdU, alpha, N, G, axis
wuppertal_smearU, alpha, N, G, axis
wuppertal_smear_bcderivU, alpha, N, G_ddmap, axis

Names in flow and spectroscopy

wilson-flow

NameArguments
wilson_flowU, eps, opt
gradflow_rkstep_gauge_nodeseps, u
gradflow_rkstep_gaugeeps, u
gradflow_rkint_gaugeeps, n, u
gradflow_rkint_gaugelisteps, n, u
gradflow_rkstep_fieldeps, u012, f
gradflow_rkstep_field_adjeps, u012, f3
gradflow_rkstep_gauge_fieldeps, u, f_tab, f_adj_tab
gradflow_rkint_gaugelist_fieldeps, n, u, ftab0
gradflow_rkint_field_adjeps, n, ulist, ftab_n

baryon

NameArguments
qcd.proton3d, u
qcd.antiproton3d, u

Names in Krylov solvers

CG

NameArguments
makeCGt

BiCGStab

NameArguments
makeBiCGStabt

GCR

NameArguments
makeGCRt

GMRES

NameArguments
makeGMRESt

Lanczos

NameArguments
makeLanczost

BlockSplit

NameArguments
BlockSplitt

Names in qcdlib

gauge-loops

NameArguments
qcdLib.GaugeLoops.make_matrix_xyname, table
qcdLib.GaugeLoops.make_sym_xyname, table
qcdLib.GaugeLoops.make_gen_xyname, table
qcdLib.GaugeLoops.make_mix_xyzname, table
qcdLib.GaugeLoops.make_sym_xyzname, table
qcdLib.GaugeLoops.flow_forceparams
qcdLib.GaugeLoops.actionparams
qcdLib.GaugeLoops.matrixname

gradient-flow

NameArguments
qcdLib.GradientFlow.flowforce, U, step, opt

symmetric-EQ

NameArguments
qcdLib.symmetricEQU, opts

Names in algo_optimize

NameArguments
optimize_brentax, bx, cx, f, tol, ITMAX, verbose

Names in arnoldi

NameArguments
latvec_arnoldiop, x0, eps, n_iter
print_arnoldi_matrm, ndigit

Names in bcderiv

NameArguments
bcderiv.dir_listdd
bcderiv.dir_str...
bcderiv.make_ddlistddmap
bcderiv.check_ddlistddlist

Names in cg-ritz

NameArguments
cg_ritzop_k, op_m, x0, eps, max_iter, do_max

Names in chroma_xmlheader

NameArguments
chroma_xmlheader_anisoparamt_dir, xi0, nu
chroma_xmlheader_displacement_none—
chroma_xmlheader_gauss_smearingwup_sigma, wup_n, wup_tdir
chroma_xmlheader_linksmearing_apeape_alpha, ape_n, ape_tdir, ape_accu, ape_maxiter
chroma_xmlheader_frwprop_record_infopropsrc_xml, frwprop_xml, config_info
chroma_xmlheader_seqsourceseqsrc_type, psnk, tsnk, tdir
chroma_xmlheader_seqpropquarkspintype, ferm_act_xml

Names in cps_util

NameArguments
cps_eopc_packL, a, b, sublat
cps_eopc_unpackL, ab, sublat
cps_eopc_unpack_v2L, ab, sublat
utest_cps_eopc_pack_unpackL, S
read_cps_evecL, cps_evec_file, L5, nev, evec_prec, evec_sublat
write_cps_evecL, cps_evec_qiofile, L5, nev, evec_prec, evec_sublat, evec
make_coord_index_goldL
make_evec5d_index_goldL, L5, nev
test_cps_evec_print_pointsindex_cps, index_gold
test_cps_evec_print_diffindex_cps, index_gold, cnt_max

Names in debug_util

NameArguments
print_colmat_norm_detu, title
print_gauge_norm_detu, title
check_gauge_norm_detu, tol
print_gauge_plaquetteu, title
print_field_1axisx, axis, title
debug_mem_printcfg_key, msg

Names in defl_util

NameArguments
evecs_rawdump_syncsrc, dst, io_stride

Names in dwf

NameArguments
dwf.y4to5x_4d, L5, opt
dwf.y5to4x_5d, L5
dwf.sol_midx_5d, L5
dwf.z4to5x_4d, L5, opt
dwf.z5to4x_5d, L5
dwf.reflect_inplacex_5d, L5
dwf.reflectx_5d, L5
dwf.proj_wallx, L5new, opt
dwf.is_dirferm5dx, L5, lat
dwf.wrapsolver_dirferm5dsolver_dirferm5d, L5
dwf.mdwf_g5herm_solver_OLDmdwf_solver, gauge_u, ferm_bc, L5, M5, b5, c5
make_mdwf_PV_twistedgauge_u, bc, L5, M5, b5, c5, opt

Names in dwf_split

NameArguments
dwf.print_norm2_arrv, fmt, ...
dwf.wrapsolver_dirferm5d_listnrhs_max, solver_dirferm5d_split, L5

Names in fastsmear

NameArguments
wuppertal_smear_fast_dpU, alpha, N, G, axis, t0

Names in gaugefix

NameArguments
sun_gaugefix_landauu_orig, gf_accu, gf_max_iter, aniso, or_param, verbose
sun_gaugefix_landau_relaxg, u, ic, jc, lss, aniso, or_param
su2extractcm, ic,jc
su2fillcm, su2, ic,jc
sun_from_su2su2, ic,jc
gaugefix_landau_funcu
gaugefix_landau_gradu

Names in hadspec

NameArguments
meson_2ptd, u, S
baryon_sigma_2ptd, u, S, T
baryon_lambda_2ptd, u, S, T
baryon_sigma_st_2ptd, u, S, T
baryon_lambda_naive_2ptd, u, S, T
baryon_xi_2ptd, u, S, T
baryon_c2ptbaryon, d, u

Names in headers

NameArguments
rbc_ddpairs_header_fermbcferm_bc
rbc_ddpairs_header_proptypemf, tol, ferm_bc, gf_string, ferm_act_string
rbc_ddpairs_headersrctype_str, proptype_str, ens_id, ens_label, seq_number
scidac_propagator_headerid

Names in latvec

NameArguments
latvec.dp2dfldp, opt
latvec.dfl2dpdfl, opt
latvec.dp2cmldp, opt
latvec.cml2dpcml, opt
make_random_SUn_gaugeS
make_random_dirprop_5dS, L5
make_random_dirferm_5dS, L5
dw_random_latdirfermL5, rnd
make_solver_generalsolver_df, ...
latvec.scal_nontable_v, scal
latvec.copyobj, scal, seen, scal_nontable_func
latvec.fromfunctiondim, func, arg_list
latvec.constdim, a
make_list_consta, len
latvec.asarray1dx, x_len, opt
latvec.latticev, L
latvec.gathergx, what, v
latvec.scattersx, v
latvec.zero_nontable_v
latvec.zero_likeobj, seen, zero_nontable_func
latvec.random_nontable_v, rnd
latvec.random_likeobj, rnd, seen
latvec.norm2v
latvec.conj_nontable_v
latvec.conjv
latvec.adjoinv
latvec.shiftv, mu, dir
latvec.adda, b
latvec.sum...
latvec.suba, b
latvec.scal_righta, sc
latvec.scal_leftsc, a
latvec.axpya, x, y
latvec.scalsum_left...
latvec.locvdotx, y
latvec.tocomplexv
latvec.realv
latvec.imagv
latvec.locnorm2x
latvec.vdotx, y
latvec.orthox, y_b
latvec.set_zeroa
latvec.seta, b
latvec.applyfunc, a, ...
latvec.eqa, b
latvec.nea, b
mask_alla
mask_anya
latvec.alla
latvec.anya
field_closex, y, rtol, atol
field_allclosex, y, rtol, atol
latvec.closex, y, rtol, atol
latvec.allclosex, y, rtol, atol
latvec.eopc_pair_to_singless, ss_v1, ss_v2
latvec.eopc_single_to_pairss, v12
latvec.print_eo_norm2v, title
latvec.cosanglea, b
latvec.cosangle_absa, b
latvec.cosangle_arga, b
latvec.cosangle_cosarga, b
latvec.cosangle_sinarga, b
latvec.print_cmpa, b, title
latvec.print_fpclassifyr, opt
latvec.rdiffa,b
latvec.op_xwilsond, u, is_dag
latvec.op_xwilson_oldd, u, is_dag
latvec.op_x5d, mf, is_dag
latvec.op_cloverd, g_clover, is_dag
latvec.prop_cloverg_clover
latvec.dslash_wilsond, u, Mw, is_dag
latvec.dslash_wilson_bcderiv1mu, d, u, is_dag
latvec.dslash_wilson_bcderiv2mu, d, u, is_dag
latvec.dslash_wilson_oldd, u, Mw, is_dag
latvec.dslash_wilson_cloverd, u, Mw, c_sw, g_clover, is_dag
latvec.dslash_twistedd, u, mq, mu, is_dag
latvec.op_mdwf_dminusx, gauge_u, M5, c5, is_dag
latvec.op_mdwf_mdminusx, gauge_u, M5, c5, is_dag
latvec.dslash_dwfd, u, M5, mf, is_dag
latvec.dslash_moebiusd, u, M5, mf, b5_s, c5_s, is_dag
qcd.xwilson_bcderiv1mu, u, x, opt
qcd.xwilson_bcderiv2mu, u, x, opt
latvec.op_mdwf_mdminus_bcderiv1mu, x, u, c5, is_dag
latvec.op_mdwf_mdminus_bcderiv2mu, x, u, c5, is_dag
latvec.dslash_moebius_bcderiv1mu, x, u, mf, b5_s, c5_s, is_dag
latvec.dslash_moebius_bcderiv2mu, x, u, mf, b5_s, c5_s, is_dag

Names in latvol

NameArguments
scatter_axisaxis, c_axis, vlist
gather_axisaxis, c_axis, n, v

Names in lhpc-std

NameArguments
timecallstr, func, ...
make_source_pointL, csrc
make_sourceZ, csrc, wup_a, wup_n, t_axis
make_srcgrp_pointL, csrcgrp
propagator_projectedsign, mu, src, solver
calc_mean_squared_radiusdensity, csrc, t_axis
copy_tabletab
apply_bcgauge_links, bc
complex2colmatc
complex2dirpropc
force_gctitle

Names in madcg

NameArguments
make_solver_MADCGU
make_solver_stdCG_builtinU
make_solver_stdCGU

Names in mdwf_eopc

NameArguments
latvec_mdwf_upperx, rho, sigma
latvec_inv_mdwf_upper_v1verybadlyconditionedrunawayoverflowingwayofdoingthisy, rho, sigma
latvec_inv_mdwf_upper_v2y, rho, sigma
reverse_tablex
latvec_mdwf_lowerx, rho, sigma
latvec_inv_mdwf_lowery, rho, sigma
scal_conjx
latvec_mdwfAd, M5, mf, b5_s, c5_s, is_dag
latvec_inv_mdwfAd, M5, mf, b5_s, c5_s, is_dag
latvec_mdwfBd, mf, b5_s, c5_s, is_dag
latvec_inv_mdwfBd, mf, b5_s, c5_s, is_dag
latvec_mdwfFd, u, is_dag
latvec_mdwfKd, M5, b5_s, is_dag
latvec_inv_mdwfKd, M5, b5_s, is_dag
mdwf_eopc_pc0d, u, M5, mf, b5_s, c5_s, is_dag
mdwf_eopc_sym2d, u, M5, mf, b5_s, c5_s, is_dag
mdwf_precond_sym2y, u, M5, mf, b5_s, c5_s
mdwf_unprecond_sym2y, u, M5, mf, b5_s, c5_s
mdwf_inflate_sym2t, y, u, M5, mf, b5_s, c5_s
mdwf_eopc_sym2pd, u, M5, mf, b5_s, c5_s, is_dag
mdwf_precond_sym2py, u, M5, mf, b5_s, c5_s
mdwf_unprecond_sym2py, u, M5, mf, b5_s, c5_s
mdwf_inflate_sym2pt, y, u, M5, mf, b5_s, c5_s
mdwf_eopc_sym1d, u, M5, mf, b5_s, c5_s, is_dag
mdwf_eopc_sym1mitd, u, M5, mf, b5_s, c5_s, is_dag
make_mdwf_op_refbc_U, L5, M5, mf, b5, c5, pctype

Names in mdwf_ref

NameArguments
op_Ax
op_Axx
op_A1x
op_A1xx
op_Bx
op_Bxx
op_B1x
op_B1xx
op_Fx
op_Fxx
op_Kx
op_Kxx
op_K1x
op_K1xx
op_BA1x
op_BA1Fx
op_BA1K1x
op_A1xBxFxx
op_A1xBxx
op_1mBA1Fx
op_1mFx
op_1mFxx
op_1mKFx
op_1mK1xA1xBxFxx

Names in mg_param

NameArguments
check_mg_parammg_param, opt

Names in qdpc_io

NameArguments
open_qdpc_writeL, name, finfo, volfmt, param
save_qdpc_dirfermL, fields, name, finfo, rinfo, volfmt, param
save_qdpc_colmatL, fields, name, finfo, rinfo, volfmt, param
save_qdpc_dirpropL, fields, name, finfo, rinfo, volfmt, param
save_qdpc_gaugeL, fields, name, finfo, rinfo, volfmt, param
open_qdpc_readL, name, param
load_qdpc_dirfermL, name, param
load_qdpc_colmatL, name, param
load_qdpc_colmat_listL, name, n, param
load_qdpc_gaugeL, name, param
load_qdpc_colvecL, name, param
load_qdpc_colvec_listL, name, n, param

Names in setup_util

NameArguments
mom3d_list_norm2maxmom2_max
rnd_initL, x
shift_origin_fieldf, v
make_mom_listmom2_max
make_mom_list_4dmom2_max, mom_t
range_prodranges, filter
gauge_set_bcu, bc
make_src_gridn_src, latsize, x0, dx_c, i_c
make_srcgrp_gridn_src, latsize, x0, dx_c, i_c, dx_it
parse_int_rangesr

Names in split

NameArguments
split.assert_check_split_geomsg, L
split.nrhs_split_geomsg
split.wrapsolver_list_padnrhs, solver_list
split.wrapsolver_list_chop_padnrhs, solver_list
split.wrapsolver_fakesplitnrhs, solver