Reaktoro  v2.1.1 A unified framework for modeling chemically reactive systems
SmartEquilibriumResult Struct Reference

Used to describe the result of a smart chemical equilibrium calculation. More...

#include <SmartEquilibriumResult.hpp>

Collaboration diagram for SmartEquilibriumResult:
[legend]

## Public Member Functions

auto succeeded ()
Return true if the calculation succeeded.

auto failed ()
Return true if the calculation failed.

auto predicted ()
Return true if the calculation was performed using a fast first-order Taylor prediction.

auto learned ()
Return true if the calculation was learned, not predicted, and performed using the conventional algorithm.

auto iterations ()
Return the number of iterations in the calculation (zero if prediction was successful).

auto operator+= (const SmartEquilibriumResult &other) -> SmartEquilibriumResult &
Self addition assignment to accumulate results.

## Public Attributes

SmartEquilibriumResultDuringPrediction prediction
The result of the smart approximation operation.

SmartEquilibriumResultDuringLearning learning
The result of the learning operation (if there was learning).

SmartEquilibriumTiming timing
The timing information of the operations during a smart chemical equilibrium calculation.

## Detailed Description

Used to describe the result of a smart chemical equilibrium calculation.

The documentation for this struct was generated from the following file:
{"extraction_info": {"found_math": true, "script_math_tex": 0, "script_math_asciimath": 0, "math_annotations": 0, "math_alttext": 0, "mathml": 0, "mathjax_tag": 0, "mathjax_inline_tex": 0, "mathjax_display_tex": 0, "mathjax_asciimath": 1, "img_math": 0, "codecogs_latex": 0, "wp_latex": 0, "mimetex.cgi": 0, "/images/math/codecogs": 0, "mathtex.cgi": 0, "katex": 0, "math-container": 0, "wp-katex-eq": 0, "align": 0, "equation": 0, "x-ck12": 0, "texerror": 0, "math_score": 0.31703078746795654, "perplexity": 5228.028097244832}, "config": {"markdown_headings": true, "markdown_code": true, "boilerplate_config": {"ratio_threshold": 0.18, "absolute_threshold": 10, "end_threshold": 15, "enable": true}, "remove_buttons": true, "remove_image_figures": true, "remove_link_clusters": true, "table_config": {"min_rows": 2, "min_cols": 3, "format": "plain"}, "remove_chinese": true, "remove_edit_buttons": true, "extract_latex": true}, "warc_path": "s3://commoncrawl/crawl-data/CC-MAIN-2023-06/segments/1674764499911.86/warc/CC-MAIN-20230201045500-20230201075500-00554.warc.gz"}