solver.h
Go to the documentation of this file.
1 /******************************************************************************
2 Copyright (c) 2017, Alexander W. Winkler, ETH Zurich. All rights reserved.
3 
4 Redistribution and use in source and binary forms, with or without modification,
5 are permitted provided that the following conditions are met:
6  * Redistributions of source code must retain the above copyright notice,
7  this list of conditions and the following disclaimer.
8  * Redistributions in binary form must reproduce the above copyright notice,
9  this list of conditions and the following disclaimer in the documentation
10  and/or other materials provided with the distribution.
11  * Neither the name of ETH ZURICH nor the names of its contributors may be
12  used to endorse or promote products derived from this software without
13  specific prior written permission.
14 
15 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
16 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 DISCLAIMED. IN NO EVENT SHALL ETH ZURICH BE LIABLE FOR ANY DIRECT, INDIRECT,
19 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
20 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
22 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
23 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
24 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 ******************************************************************************/
26 
27 #ifndef IFOPT_SRC_IFOPT_CORE_INCLUDE_IFOPT_SOLVER_H_
28 #define IFOPT_SRC_IFOPT_CORE_INCLUDE_IFOPT_SOLVER_H_
29 
30 #include <memory>
31 
32 #include <ifopt/problem.h>
33 
34 namespace ifopt {
35 
48 class Solver {
49 public:
50  using Ptr = std::shared_ptr<Solver>;
51 
52  virtual ~Solver () = default;
53 
57  virtual void Solve(Problem& nlp) = 0;
58 
59 
64  int GetReturnStatus () const { return status_; };
65 
66 protected:
67  int status_;
68 };
69 
70 } /* namespace ifopt */
71 
72 #endif /* IFOPT_SRC_IFOPT_CORE_INCLUDE_IFOPT_SOLVER_H_ */
A generic optimization problem with variables, costs and constraints.
Definition: problem.h:97
int GetReturnStatus() const
Get the return status for the optimization.
Definition: solver.h:64
Solver interface implemented by IPOPT and SNOPT.
Definition: solver.h:48
int status_
Definition: solver.h:64
common namespace for all elements in this library.
Definition: bounds.h:33
std::shared_ptr< Solver > Ptr
Definition: solver.h:50
virtual void Solve(Problem &nlp)=0
Uses a specific solver (IPOPT, SNOPT) to solve the NLP.
virtual ~Solver()=default


ifopt
Author(s): Alexander W. Winkler
autogenerated on Fri Jan 22 2021 03:47:32