config_schema.h

Go to the documentation of this file.

#pragma once
/**
 * @file config_schema.h
 * @brief The keys a LINE solver accepts under options.config, in all four codebases.
 *
 * GENERATED by doc/generate-config-schema.py from doc/line-config.schema.json. Do not edit.
 *
 * The C++ engine takes no options.config map: a key reaches it only as the
 * line-cli flag named in `cpp` (empty when the engine does not implement it).
 * The other columns let a C++ caller say which codebase does.
 */
 
#include <array>
#include <cstring>
 
namespace line {
namespace solvers {
 
/** One options.config key; an empty placement means "not implemented there". */
struct ConfigKey {
    const char* name;
    const char* matlab;
    const char* java;
    const char* python;
    const char* cpp;
    const char* aliases;  ///< comma-separated
    const char* values;   ///< comma-separated admissible values; empty when any string is taken
    bool internal;
};
 
inline const std::array<ConfigKey, 168>& config_schema() {
    static const std::array<ConfigKey, 168> keys = {{
        {"aghq_nodes", "config", "config", "config", "", "", "", false},
        {"algorithm", "config", "", "config", "--cdf-algorithm", "", "exact,rd", false},
        {"alpha", "config", "", "", "", "", "", false},
        {"aoi_preemption", "config", "config", "option:aoi_preemption", "", "", "", false},
        {"bgaggr", "config", "config", "config", "", "", "", false},
        {"bgenv", "config", "", "", "", "", "lump,full", false},
        {"bgstates_max", "config", "config", "config", "", "", "", false},
        {"chain_aggregation", "config", "config", "config", "", "", "", false},
        {"cimethod", "config", "option:LDESOptions.cimethod", "option:cimethod", "--ldes-cimethod", "", "obm,bm,spectral,none", false},
        {"ciminbatch", "config", "option:LDESOptions.ciminbatch", "option:ciminbatch", "", "", "", false},
        {"ciminobs", "config", "option:LDESOptions.ciminobs", "option:ciminobs", "", "", "", false},
        {"cnvgbatch", "config", "option:LDESOptions.cnvgbatch", "option:cnvgbatch", "", "", "", false},
        {"cnvgchk", "config", "option:LDESOptions.cnvgchk", "option:cnvgchk", "", "", "", false},
        {"cnvgon", "config", "option:LDESOptions.cnvgon", "option:cnvgon", "--ldes-cnvgon", "", "", false},
        {"cnvgtol", "config", "option:LDESOptions.cnvgtol", "option:cnvgtol", "--ldes-cnvgtol", "", "", false},
        {"compress", "config", "config", "config", "", "", "default,none,mixture,mixture.order1,mixture.order2,mamap2,mamap2.fb,m3pp.approx_cov,m3pp.approx_ag,m3pp.exact_delta,m3pp.approx_delta", false},
        {"container", "config", "option:container", "option:container", "", "", "", false},
        {"ctmc_tv_ngrid", "config", "config", "config", "--ctmc-tv-ngrid", "", "", false},
        {"da", "config", "config", "config", "", "", "courtois,kms,takahashi,multi", false},
        {"da_damping", "config", "", "config", "", "", "", false},
        {"da_iter", "config", "config", "config", "", "", "", false},
        {"da_miniter", "config", "", "config", "", "", "", false},
        {"da_nanstop", "config", "", "config", "", "", "", false},
        {"da_norm", "config", "", "", "", "", "", false},
        {"dae_maxcov", "config", "config", "config", "", "", "", false},
        {"dae_maxstate", "config", "config", "config", "", "", "", false},
        {"decomp", "config", "", "", "", "", "", false},
        {"dep_scv", "config", "config", "", "", "", "qna,etaqa", false},
        {"dt_maxlevel", "config", "config", "config", "", "", "", false},
        {"endpoints", "config", "option:AGOptions.endpoints", "config", "", "", "", false},
        {"env_alpha", "config", "config", "", "", "", "", false},
        {"env_init", "config", "config", "config", "--env-init", "", "", false},
        {"etaqa_trunc", "config", "config", "config", "", "", "", false},
        {"eventcache", "config", "config", "", "", "", "", false},
        {"exec", "config", "option:AGOptions.exec", "config", "", "", "", false},
        {"fau_delta", "config", "config", "config", "--fau-delta", "", "", false},
        {"fau_epsilon", "config", "config", "config", "--fau-epsilon", "", "", false},
        {"fau_ngrid", "config", "config", "", "", "", "", false},
        {"fes_stations", "config", "config", "config", "", "", "", false},
        {"fj_accuracy", "config", "", "", "--fj-accuracy", "", "", false},
        {"fj_sync_q_len", "config", "config", "config", "", "", "", false},
        {"fj_tmode", "config", "", "", "--fj-tmode", "", "NARE,Sylvester", false},
        {"fj_warmstart", "config", "config", "config,option:fj_warmstart", "", "", "", false},
        {"fluid_boundary", "config", "config", "config", "--fluid-boundary", "", "reflect,diffusion", false},
        {"fluid_earlystop", "config", "config", "config", "", "", "", false},
        {"fluid_warmstart", "config", "", "", "", "", "", false},
        {"fork_join", "config", "config", "option:fork_join", "--fork-join", "", "default,mmt,fjt,ht,heidelberger-trivedi", false},
        {"gd_max_entries", "config", "", "", "", "", "", false},
        {"gmres_restart", "", "config", "", "", "", "", false},
        {"hide_immediate", "config", "config", "config,option:hide_immediate", "", "", "", false},
        {"highvar", "config", "config", "config", "", "", "default,none,hvmva,interp", false},
        {"immediate_tol", "config", "config", "config", "", "", "", false},
        {"init_cov", "config", "config", "config", "", "", "", false},
        {"init_qcov", "config", "config", "config", "", "", "", false},
        {"init_qlen", "config", "config", "config", "", "", "", false},
        {"interlock", "config", "config", "config", "", "", "", true},
        {"interlock_chain", "config", "config", "config", "", "", "", true},
        {"interlock_maxpaths", "config", "config", "config", "--interlock-maxpaths", "", "", false},
        {"interlock_method", "config", "config", "config", "--interlock-method", "", "ilrate,refpath,none", false},
        {"interlock_refpath_scope", "config", "config", "config", "--interlock-refpath-scope", "", "merging,all", false},
        {"interlocking", "config", "config", "config", "--no-interlocking", "", "", false},
        {"kp_init_sol", "config", "config", "config", "", "", "", false},
        {"layer_init", "config", "config", "config", "", "", "none,bound,boxbound,mw", false},
        {"layering", "config", "config", "config", "--method", "", "srvn,flat,squashed", false},
        {"lld", "config", "config", "config", "--lld", "", "", false},
        {"ln_transient", "config", "config", "config", "--ln-transient", "", "coupled,decoupled", false},
        {"ln_transient_channels", "config", "config", "config", "--ln-transient-channels", "", "", false},
        {"ln_transient_iter_max", "config", "config", "config", "", "", "", false},
        {"ln_transient_tol", "config", "config", "config", "", "", "", false},
        {"lsoda_retry", "config", "", "", "", "", "", true},
        {"map_env", "config", "config", "config", "--map-env", "", "auto,off,default", false},
        {"map_env_maxstages", "config", "config", "config", "--map-env-maxstages", "", "", false},
        {"map_env_method", "config", "config", "config", "--map-env-method", "", "auto,meanfield,dec,avg", false},
        {"mapmsg_quantization", "config", "config", "config", "--mapmsg-quantization", "", "", false},
        {"maxStates", "config", "option:AGOptions.maxStates", "config", "--max-states", "", "", false},
        {"mcmc_batches", "config", "config", "config", "", "", "", false},
        {"mcmc_burnin", "config", "config", "config", "", "", "", false},
        {"mdd_maxiter", "config", "config", "config", "--mdd-maxiter", "", "", false},
        {"mdd_tol", "config", "config", "config", "--mdd-tol", "", "", false},
        {"mem_maxiter", "config", "", "config", "", "", "", false},
        {"mem_tol", "config", "", "config", "", "", "", false},
        {"mem_verbose", "config", "", "config", "", "", "", false},
        {"merge", "config", "config", "config", "", "", "default,super,mixture,interpos", false},
        {"mol_iter_max", "config", "config", "config", "--mol-iter-max", "", "", false},
        {"mol_iter_tol", "config", "config", "config", "--mol-iter-tol", "", "", false},
        {"mol_relax_factor", "config", "config", "config", "--mol-relax-factor", "", "", false},
        {"moment_cov", "config", "config", "config", "", "", "", true},
        {"moment_maxstate", "config", "config", "config", "", "", "", false},
        {"moment_sigma2", "config", "config", "config", "", "", "", false},
        {"mserbatch", "config", "option:LDESOptions.mserbatch", "option:mserbatch", "", "", "", false},
        {"multiserver", "config", "config", "config", "--multiserver", "", "default,seidmann,softmin,suri,conway,erlang,krzesinski,rolia,reiser,zhou,schmidt,bruell,reiser-ps,rolia-ps,lld,exact,loaddep,load-dependent", false},
        {"nhpp_sched", "config", "config", "config", "", "", "", false},
        {"nlp_alpha", "config", "config", "config", "--nlp-alpha", "", "", false},
        {"nlp_fork", "config", "config", "config", "--nlp-fork", "", "", false},
        {"nlp_maxiter", "config", "config", "config", "--nlp-maxiter", "", "", false},
        {"nlp_source", "", "", "config", "", "", "", false},
        {"nlp_warm", "config", "config", "config", "--nlp-warm", "", "", false},
        {"nonmkv", "config", "config", "config", "--nonmkv", "", "bernstein,none", false},
        {"nonmkvorder", "config", "config", "config", "", "", "", false},
        {"np_priority", "config", "config", "config", "", "", "default,cl,shadow", false},
        {"nreplicas", "config", "config", "config", "", "", "", false},
        {"num_cdf_pts", "config", "config", "config", "", "", "", false},
        {"numthreads", "config", "option:LDESOptions.numThreads", "option:numthreads", "--ldes-numthreads", "", "", false},
        {"nworkers", "config", "option:AGOptions.nworkers", "config", "", "", "", false},
        {"obmoverlap", "config", "option:LDESOptions.obmoverlap", "option:obmoverlap", "", "", "", false},
        {"orbit_maxlevel", "config", "config", "config", "", "", "", false},
        {"orbit_tailtol", "config", "config", "config", "", "", "", false},
        {"passage_method", "config", "config", "config", "--passage-method", "", "expm,lt", false},
        {"phfit", "config", "config", "config", "", "", "cme,ph,hyperexp", false},
        {"preserveDet", "config", "config", "config", "", "", "", false},
        {"pstar", "config", "config", "config,option:pstar", "--pstar", "", "", false},
        {"qbdphases_max", "config", "config", "config", "", "", "", false},
        {"qrf_alpha", "config", "option:qrfAlpha", "config", "--qrf-alpha", "", "", false},
        {"qrf_maxvars", "config", "", "config", "", "", "", false},
        {"qrf_params", "config", "option:qrfParams", "config", "--qrf-params", "", "", false},
        {"rate_sched", "config", "config", "config", "--rate-sched", "", "", false},
        {"rate_traj", "config", "config:rate_traj_tgrid+rate_traj_mmat", "config", "", "", "", false},
        {"relax", "config", "config", "config", "", "", "auto,fixed,adaptive,none", false},
        {"relax_factor", "config", "config", "config", "", "", "", false},
        {"relax_history", "config", "config", "config", "", "", "", false},
        {"relax_min", "config", "config", "config", "", "", "", false},
        {"remote", "config", "config", "option:remote", "--remote", "", "", false},
        {"remote_url", "config", "config", "option:remote_url", "--remote-url", "", "", false},
        {"replications", "config", "option:LDESOptions.replications,config", "config,option:replications", "--jmt-replications", "", "", false},
        {"rqna_alpha", "config", "config", "config", "", "", "", false},
        {"rqna_beta", "config", "config", "config", "", "", "", false},
        {"rqna_feedback_elim", "config", "config", "config", "", "", "", false},
        {"rqt_alpha_a", "config", "config", "config", "", "", "", false},
        {"rqt_alpha_s", "config", "config", "config", "", "", "", false},
        {"rqt_exact", "config", "config", "config", "", "", "", false},
        {"rqt_regime", "config", "config", "config", "", "", "independent,default,normal,pareto", false},
        {"runLengthPlan", "config", "config", "config", "", "", "", false},
        {"sjn_lattice_max", "config", "config", "config", "", "", "", false},
        {"sjn_lfactor", "config", "config", "config", "", "", "", false},
        {"sjn_ns", "config", "config", "config", "", "", "", false},
        {"sjn_umax", "config", "config", "config", "", "", "", false},
        {"slotlength", "config", "option:LDESOptions.slotLength,config", "config,option:slot_length", "--slotlength", "slot_length", "", false},
        {"slotted", "config", "option:LDESOptions.slotted,config", "config,option:slotted", "--slotted", "", "", false},
        {"space_max", "config", "config", "config,option:space_max", "", "", "", false},
        {"spectrallowfreqfrac", "config", "option:LDESOptions.spectralLowFreqFrac", "option:spectral_low_freq_frac", "", "spectralLowFreqFrac", "", false},
        {"spn_bound", "config", "", "config", "", "", "", false},
        {"spnlp_assumelive", "config", "", "config", "", "", "", false},
        {"spnlp_init", "config", "", "config", "", "", "", false},
        {"state_space_gen", "config", "config", "config", "", "", "", false},
        {"stochiter", "config", "config", "config", "", "", "auto,rm,crn,off", false},
        {"stochiter_a0", "config", "config", "config", "", "", "", false},
        {"stochiter_alpha", "config", "config", "config", "", "", "", false},
        {"stochiter_burnin", "config", "config", "config", "", "", "", false},
        {"stochiter_conseq", "config", "config", "config", "", "", "", false},
        {"symbolic", "config", "config", "config", "--symbolic", "", "", false},
        {"symbolic_timeout", "config", "config", "config", "", "", "", false},
        {"sync_phases", "config", "config", "config", "--sync-phases", "", "", false},
        {"tbi_cells", "config", "config", "config", "", "", "", false},
        {"tbi_cellsize", "config", "config", "config", "", "", "", false},
        {"tbi_iter_max", "config", "config", "config", "", "", "", false},
        {"tbi_iteration", "config", "", "", "", "", "", false},
        {"tbi_parallel", "config", "", "", "", "", "", false},
        {"tbi_tol", "config", "config", "config", "", "", "", false},
        {"timescale", "config", "config", "config", "--timescale", "", "auto,discrete,continuous", false},
        {"tranfilter", "config", "option:LDESOptions.tranfilter", "option:tranfilter", "--ldes-tranfilter", "", "mser5,fixed,none", false},
        {"tranobs", "config", "option:LDESOptions.tranobs", "option:tranobs", "", "", "", false},
        {"transform", "config", "config", "config", "", "", "", false},
        {"transform_depth", "config", "config", "config", "", "", "", true},
        {"transient_method", "config", "config", "config", "--transient-method", "", "ode,fau", false},
        {"warmstart", "config", "config", "config", "--warmstart", "", "", false},
        {"warmup", "", "config", "", "", "", "", false},
        {"warmupfrac", "config", "option:LDESOptions.warmupfrac,config", "option:warmupfrac", "--warmupfrac", "", "", false},
        {"worker_timeout", "config", "option:AGOptions.workerTimeout", "config", "", "", "", false},
    }};
    return keys;
}
 
/** The key spelled `name`, by its canonical name or an alias; nullptr when unknown. */
inline const ConfigKey* config_key(const char* name) {
    const std::size_t n = std::strlen(name);
    for (const ConfigKey& k : config_schema()) {
        if (std::strcmp(k.name, name) == 0) return &k;
        for (const char* a = k.aliases; *a;) {
            const char* e = std::strchr(a, ',');
            const std::size_t len = e ? static_cast<std::size_t>(e - a) : std::strlen(a);
            if (len == n && std::strncmp(a, name, n) == 0) return &k;
            a = e ? e + 1 : a + len;
        }
    }
    return nullptr;
}
 
/** Whether `value` is admissible for `k`: always true when the key lists no values. */
inline bool config_value_ok(const ConfigKey& k, const char* value) {
    if (!*k.values) return true;
    const std::size_t n = std::strlen(value);
    for (const char* a = k.values; *a;) {
        const char* e = std::strchr(a, ',');
        const std::size_t len = e ? static_cast<std::size_t>(e - a) : std::strlen(a);
        if (len == n && std::strncmp(a, value, n) == 0) return true;
        a = e ? e + 1 : a + len;
    }
    return false;
}
 
/**
 * The config key a line-cli flag carries; nullptr when the flag carries none.
 * --method carries the solver method: a key placed there (layering) only folds into it,
 * so its values never constrain the flag.
 */
inline const ConfigKey* config_key_for_flag(const char* flag) {
    if (std::strcmp(flag, "--method") == 0) return nullptr;
    for (const ConfigKey& k : config_schema()) {
        if (std::strcmp(k.cpp, flag) == 0) return &k;
    }
    return nullptr;
}
 
}  // namespace solvers
}  // namespace line