Scippy

SCIP

Solving Constraint Integer Programs

nlpi_worhp.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 2002-2022 Zuse Institute Berlin */
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_worhp.h
26  * @brief Worhp NLP interface
27  * @ingroup NLPIS
28  * @author Benjamin Mueller
29  * @author Renke Kuhlmann
30  */
31 
32 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
33 
34 #ifndef __SCIP_NLPI_WORHP_H__
35 #define __SCIP_NLPI_WORHP_H__
36 
37 #include "scip/type_nlpi.h"
38 
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 /** create solver interface for Worhp solver and includes it into SCIP, if Worhp is available
44  *
45  * @ingroup NLPIIncludes
46  */
47 SCIP_EXPORT
49  SCIP* scip, /**< SCIP data structure */
50  SCIP_Bool useip /**< TRUE for using Interior Point, FALSE for SQP */
51  );
52 
53 /**@addtogroup NLPIS
54  *
55  * @{
56  */
57 
58 /** gets string that identifies Worhp (version number) */
59 SCIP_EXPORT
60 const char* SCIPgetSolverNameWorhp(
61  void
62  );
63 
64 /** gets string that describes Worhp (version number) */
65 SCIP_EXPORT
66 const char* SCIPgetSolverDescWorhp(
67  void
68  );
69 
70 /** returns whether Worhp is available, i.e., whether it has been linked in */
71 SCIP_EXPORT
73  void
74  );
75 
76 /** @} */
77 
78 #ifdef __cplusplus
79 }
80 #endif
81 
82 #endif /* __SCIP_NLPI_WORHP_H__ */
SCIP_RETCODE SCIPincludeNlpSolverWorhp(SCIP *scip, SCIP_Bool useip)
Definition: nlpi_worhp.c:1590
const char * SCIPgetSolverDescWorhp(void)
Definition: nlpi_worhp.c:1660
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:63
SCIP_Bool SCIPisWorhpAvailableWorhp(void)
Definition: nlpi_worhp.c:1668
#define SCIP_Bool
Definition: def.h:93
const char * SCIPgetSolverNameWorhp(void)
Definition: nlpi_worhp.c:1646
type definitions for NLP solver interfaces