OptimumSolver.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
 
// C++ includes
#include <memory>
 
// Reaktoro includes
#include <Reaktoro/Math/Matrix.hpp>
 
namespace Reaktoro {
 
// Forward declarations
struct OptimumOptions;
struct OptimumProblem;
struct OptimumResult;
struct OptimumSensitivity;
struct OptimumState;
enum class OptimumMethod;
 
class OptimumSolver
{
public:
    OptimumSolver();
 
    OptimumSolver(OptimumMethod method);
 
    OptimumSolver(const OptimumSolver& other);
 
    virtual ~OptimumSolver();
 
    auto operator=(OptimumSolver other) -> OptimumSolver&;
 
    auto setMethod(OptimumMethod method) -> void;
 
    auto approximate(const OptimumProblem& problem, OptimumState& state) -> OptimumResult;
 
    auto approximate(const OptimumProblem& problem, OptimumState& state, const OptimumOptions& options) -> OptimumResult;
 
    auto solve(const OptimumProblem& problem, OptimumState& state) -> OptimumResult;
 
    auto solve(const OptimumProblem& problem, OptimumState& state, const OptimumOptions& options) -> OptimumResult;
 
    auto dxdp(const Vector& dgdp, const Vector& dbdp) -> Vector;
 
private:
    struct Impl;
 
    std::unique_ptr<Impl> pimpl;
};
 
} // namespace Reaktoro