SmartEquilibriumResult Struct Reference
Used to describe the result of a smart chemical equilibrium calculation. More...
#include <SmartEquilibriumResult.hpp>
Collaboration diagram for SmartEquilibriumResult:
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:
- Reaktoro/Equilibrium/SmartEquilibriumResult.hpp