OptimumResult.hpp

// Reaktoro is a unified framework for modeling chemically reactive systems.
//
// Copyright (C) 2014-2018 Allan Leal
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library. If not, see <http://www.gnu.org/licenses/>.
 
#pragma once
 
namespace Reaktoro {
 
struct OptimumResult
{
    bool succeeded = false;
 
    unsigned iterations = 0;
 
    unsigned num_objective_evals = 0;
 
    double convergence_rate = 0;
 
    double error = 0;
 
    double time = 0;
 
    double time_objective_evals = 0;
 
    double time_constraint_evals = 0;
 
    double time_linear_systems = 0;
 
    auto operator+=(const OptimumResult& other) -> OptimumResult&;
};
 
} // namespace Reaktoro