eonc::JobResultProvenance Struct Reference

Optimizer, xtsci, eindir, and rgpot identity carried on a JobResult. More...

#include <JobResult.h>

Public Member Functions
std::string	text () const

Public Attributes
std::string	backend
std::string	engine_version
std::string	engine_build_identity
std::string	rgpot_name
std::string	rgpot_version
bool	xtsci {false}
std::uint16_t	xts_abi_major {0}
std::uint16_t	xts_abi_minor {0}
std::uint16_t	xts_abi_layout {0}
bool	has_eindir {false}
std::uint32_t	eindir_abi_major {0}
std::uint32_t	eindir_abi_minor {0}
std::uint32_t	eindir_objective_layout {0}
std::uint64_t	eindir_objective_size {0}
std::uint64_t	eindir_objective_align {0}
std::uint32_t	eindir_dlpack_major {0}
std::uint32_t	eindir_dlpack_minor {0}
std::uint64_t	eindir_features {0}

Static Public Attributes
static constexpr std::uint16_t	readcon_spec_version = 3
static constexpr std::string_view	readcon_min_version = "0.14.9"
static constexpr std::string_view	eon_schema_min_version = "0.2.3"
static constexpr std::string_view	rgpycrumbs_min_version = "1.10.4"
static constexpr std::string_view	chemparseplot_min_version = "1.9.17"
static constexpr std::string_view	rgpot_pin = "3.2.0"

Detailed Description

Optimizer, xtsci, eindir, and rgpot identity carried on a JobResult.

Empty backend means the record is absent. Legacy results.dat parsing is unchanged: these lines are extra value-key records.

Definition at line 35 of file JobResult.h.

Member Function Documentation

text()

std::string eonc::JobResultProvenance::text ( ) const

inline

Definition at line 62 of file JobResult.h.

                         {
    if (backend.empty()) {
      return {};
    }
    std::ostringstream out;
    out << backend << " optimizer_backend\n";
    out << "eon.optimizer.v1 optimizer_provenance_schema\n";
    out << "eon.compatibility.v1 compatibility_schema\n";
    out << readcon_spec_version << " compatibility_readcon_spec_version\n";
    out << readcon_min_version << " compatibility_readcon_min_version\n";
    out << eon_schema_min_version << " compatibility_eon_schema_min_version\n";
    out << rgpycrumbs_min_version << " compatibility_rgpycrumbs_min_version\n";
    out << chemparseplot_min_version
        << " compatibility_chemparseplot_min_version\n";
    out << "eon engine_id\n";
    if (!engine_version.empty()) {
      out << engine_version << " engine_version\n";
    }
    if (!engine_build_identity.empty()) {
      out << engine_build_identity << " engine_build_identity\n";
    }
    if (!rgpot_name.empty()) {
      out << rgpot_name << " rgpot_name\n";
    }
    if (!rgpot_version.empty()) {
      out << "eon.rgpot.v1 rgpot_schema\n";
      out << rgpot_version << " rgpot_version\n";
    }
    if (xtsci) {
      out << "eon.objective compatibility_engine_protocol_family\n";
      out << "1 compatibility_engine_protocol_major\n";
      out << "0 compatibility_engine_protocol_minor\n";
      out << xts_abi_major << " compatibility_engine_abi_major\n";
      out << xts_abi_minor << " compatibility_engine_abi_minor\n";
      out << xts_abi_layout << " compatibility_engine_layout_revision\n";
      out << xts_abi_major << " optimizer_xts_abi_major\n";
      out << xts_abi_minor << " optimizer_xts_abi_minor\n";
      out << xts_abi_layout << " optimizer_xts_abi_layout\n";
    }
    if (has_eindir) {
      out << eindir_abi_major << " optimizer_eindir_abi_major\n";
      out << eindir_abi_minor << " optimizer_eindir_abi_minor\n";
      out << eindir_objective_layout << " optimizer_eindir_objective_layout\n";
      out << eindir_objective_size << " optimizer_eindir_objective_size\n";
      out << eindir_objective_align << " optimizer_eindir_objective_align\n";
      out << eindir_dlpack_major << " optimizer_eindir_dlpack_major\n";
      out << eindir_dlpack_minor << " optimizer_eindir_dlpack_minor\n";
      out << eindir_features << " optimizer_eindir_features\n";
    }
    return out.str();
  }

Member Data Documentation

backend

std::string eonc::JobResultProvenance::backend

Definition at line 36 of file JobResult.h.

chemparseplot_min_version

std::string_view eonc::JobResultProvenance::chemparseplot_min_version = "1.9.17"

staticconstexpr

Definition at line 59 of file JobResult.h.

eindir_abi_major

std::uint32_t eonc::JobResultProvenance::eindir_abi_major {0}

Definition at line 46 of file JobResult.h.

{0};

eindir_abi_minor

std::uint32_t eonc::JobResultProvenance::eindir_abi_minor {0}

Definition at line 47 of file JobResult.h.

{0};

eindir_dlpack_major

std::uint32_t eonc::JobResultProvenance::eindir_dlpack_major {0}

Definition at line 51 of file JobResult.h.

{0};

eindir_dlpack_minor

std::uint32_t eonc::JobResultProvenance::eindir_dlpack_minor {0}

Definition at line 52 of file JobResult.h.

{0};

eindir_features

std::uint64_t eonc::JobResultProvenance::eindir_features {0}

Definition at line 53 of file JobResult.h.

{0};

eindir_objective_align

std::uint64_t eonc::JobResultProvenance::eindir_objective_align {0}

Definition at line 50 of file JobResult.h.

{0};

eindir_objective_layout

std::uint32_t eonc::JobResultProvenance::eindir_objective_layout {0}

Definition at line 48 of file JobResult.h.

{0};

eindir_objective_size

std::uint64_t eonc::JobResultProvenance::eindir_objective_size {0}

Definition at line 49 of file JobResult.h.

{0};

engine_build_identity

std::string eonc::JobResultProvenance::engine_build_identity

Definition at line 38 of file JobResult.h.

engine_version

std::string eonc::JobResultProvenance::engine_version

Definition at line 37 of file JobResult.h.

eon_schema_min_version

std::string_view eonc::JobResultProvenance::eon_schema_min_version = "0.2.3"

staticconstexpr

Definition at line 57 of file JobResult.h.

has_eindir

bool eonc::JobResultProvenance::has_eindir {false}

Definition at line 45 of file JobResult.h.

{false};

readcon_min_version

std::string_view eonc::JobResultProvenance::readcon_min_version = "0.14.9"

staticconstexpr

Definition at line 56 of file JobResult.h.

readcon_spec_version

std::uint16_t eonc::JobResultProvenance::readcon_spec_version = 3

staticconstexpr

Definition at line 55 of file JobResult.h.

rgpot_name

std::string eonc::JobResultProvenance::rgpot_name

Definition at line 39 of file JobResult.h.

rgpot_pin

std::string_view eonc::JobResultProvenance::rgpot_pin = "3.2.0"

staticconstexpr

Definition at line 60 of file JobResult.h.

rgpot_version

std::string eonc::JobResultProvenance::rgpot_version

Definition at line 40 of file JobResult.h.

rgpycrumbs_min_version

std::string_view eonc::JobResultProvenance::rgpycrumbs_min_version = "1.10.4"

staticconstexpr

Definition at line 58 of file JobResult.h.

xts_abi_layout

std::uint16_t eonc::JobResultProvenance::xts_abi_layout {0}

Definition at line 44 of file JobResult.h.

{0};

xts_abi_major

std::uint16_t eonc::JobResultProvenance::xts_abi_major {0}

Definition at line 42 of file JobResult.h.

{0};

xts_abi_minor

std::uint16_t eonc::JobResultProvenance::xts_abi_minor {0}

Definition at line 43 of file JobResult.h.

{0};

xtsci

bool eonc::JobResultProvenance::xtsci {false}

Definition at line 41 of file JobResult.h.

{false};

---

The documentation for this struct was generated from the following file:

• /home/runner/work/eOn/eOn/include/eon/JobResult.h