Reaktoro 
A unified framework for modeling chemically reactive systems
OptimumSolverActNewton.hpp
1 // Reaktoro is a unified framework for modeling chemically reactive systems.
2 //
3 // Copyright (C) 2014-2015 Allan Leal
4 //
5 // This program is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // This program is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18 #pragma once
19 
20 // Reaktoro includes
21 #include <Reaktoro/Optimization/OptimumSolverBase.hpp>
22 
23 namespace Reaktoro {
24 
25 // Forward declarations
26 struct OptimumOptions;
27 struct OptimumProblem;
28 struct OptimumResult;
29 struct OptimumSensitivity;
30 struct OptimumState;
31 
34 {
35 public:
38 
41 
43  virtual ~OptimumSolverActNewton();
44 
47 
51  virtual auto solve(const OptimumProblem& problem, OptimumState& state) -> OptimumResult;
52 
57  virtual auto solve(const OptimumProblem& problem, OptimumState& state, const OptimumOptions& options) -> OptimumResult;
58 
62  virtual auto dxdp(const Vector& dgdp, const Vector& dbdp) -> Vector;
63 
65  virtual auto clone() const -> OptimumSolverBase*;
66 
67 private:
68  struct Impl;
69 
70  std::unique_ptr<Impl> pimpl;
71 };
72 
73 } // namespace Reaktoro
A type that describes the non-linear constrained optimisation problem.
Definition: OptimumProblem.hpp:48
virtual auto dxdp(const Vector &dgdp, const Vector &dbdp) -> Vector
Return the sensitivity dx/dp of the solution x with respect to a vector of parameters p...
Definition: OptimumSolverActNewton.cpp:470
The class that implements the ActNewton algorithm using an active-set strategy.
Definition: OptimumSolverActNewton.hpp:33
OptimumSolverActNewton()
Construct a default OptimumSolverActNewton instance.
Definition: OptimumSolverActNewton.cpp:443
The base class for all optimization algorithms.
Definition: OptimumSolverBase.hpp:35
Eigen::VectorXd Vector
Define an alias to the vector type of the Eigen library.
Definition: Matrix.hpp:384
auto operator=(OptimumSolverActNewton other) -> OptimumSolverActNewton &
Assign an OptimumSolverActNewton instance to this.
Definition: OptimumSolverActNewton.cpp:454
A type that describes the options of a optimisation calculation.
Definition: OptimumOptions.hpp:186
virtual auto solve(const OptimumProblem &problem, OptimumState &state) -> OptimumResult
Solve an optimisation problem.
Definition: OptimumSolverActNewton.cpp:460
A type that describes the state of an optimum solution.
Definition: OptimumState.hpp:28
The namespace containing all components of the Reaktoro library.
Definition: ChemicalScalar.hpp:24
virtual ~OptimumSolverActNewton()
Destroy this OptimumSolverActNewton instance.
Definition: OptimumSolverActNewton.cpp:451
A type that describes the result of an optimisation calculation.
Definition: OptimumResult.hpp:23
virtual auto clone() const -> OptimumSolverBase *
Return a clone of this instance.
Definition: OptimumSolverActNewton.cpp:477