Scippy

SCIP

Solving Constraint Integer Programs

nlpi_filtersqp.h
Go to the documentation of this file.
1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2 /* */
3 /* This file is part of the program and library */
4 /* SCIP --- Solving Constraint Integer Programs */
5 /* */
6 /* Copyright (c) 2002-2023 Zuse Institute Berlin (ZIB) */
7 /* */
8 /* Licensed under the Apache License, Version 2.0 (the "License"); */
9 /* you may not use this file except in compliance with the License. */
10 /* You may obtain a copy of the License at */
11 /* */
12 /* http://www.apache.org/licenses/LICENSE-2.0 */
13 /* */
14 /* Unless required by applicable law or agreed to in writing, software */
15 /* distributed under the License is distributed on an "AS IS" BASIS, */
16 /* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
17 /* See the License for the specific language governing permissions and */
18 /* limitations under the License. */
19 /* */
20 /* You should have received a copy of the Apache-2.0 license */
21 /* along with SCIP; see the file LICENSE. If not visit scipopt.org. */
22 /* */
23 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
24 
25 /**@file nlpi_filtersqp.h
26  * @brief filterSQP NLP interface
27  * @ingroup NLPIS
28  * @author Stefan Vigerske
29  */
30 
31 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
32 
33 #ifndef __SCIP_NLPI_FILTERSQP_H__
34 #define __SCIP_NLPI_FILTERSQP_H__
35 
36 #include "scip/type_nlpi.h"
37 
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 /** create solver interface for filterSQP solver and include it into SCIP, if filterSQP is available
43  *
44  * @ingroup NLPIIncludes
45  */
46 SCIP_EXPORT
48  SCIP* scip /**< SCIP data structure */
49  );
50 
51 /**@addtogroup NLPIS
52  *
53  * @{
54  */
55 
56 /** gets string that identifies filterSQP */
57 SCIP_EXPORT
58 const char* SCIPgetSolverNameFilterSQP(void);
59 
60 /** gets string that describes filterSQP */
61 SCIP_EXPORT
62 const char* SCIPgetSolverDescFilterSQP(void);
63 
64 /** returns whether filterSQP is available, i.e., whether it has been linked in */
65 SCIP_EXPORT
67 
68 /** @} */
69 
70 #ifdef __cplusplus
71 }
72 #endif
73 
74 #endif /* __SCIP_NLPI_FILTERSQP_H__ */
SCIP_RETCODE SCIPincludeNlpSolverFilterSQP(SCIP *scip)
const char * SCIPgetSolverDescFilterSQP(void)
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:63
SCIP_Bool SCIPisFilterSQPAvailableFilterSQP(void)
#define SCIP_Bool
Definition: def.h:93
type definitions for NLP solver interfaces
const char * SCIPgetSolverNameFilterSQP(void)