Scippy

SCIP

Solving Constraint Integer Programs

nlpi_worhp_dummy.c
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-2024 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_worhp_dummy.c
26  * @ingroup DEFPLUGINS_NLPI
27  * @brief dummy WORHP NLP interface
28  * @author Benjamin Mueller
29  *
30  * This file contains dummy implementations of the interface methods for the Worhp interface.
31  * It is used when SCIP is build without Worhp.
32  */
33 
34 #include "scip/nlpi_worhp.h"
35 
36 /** create solver interface for Worhp solver and includes it into SCIP, if Worhp is available */ /*lint -e{715}*/
38  SCIP* scip, /**< SCIP data structure */
39  SCIP_Bool useip /**< TRUE for using Interior Point, FALSE for SQP */
40  )
41 { /*lint --e{715}*/
42  assert(scip != NULL);
43 
44  return SCIP_OKAY;
45 }
46 
47 /** gets string that identifies Worhp (version number) */
48 const char* SCIPgetSolverNameWorhp(void)
49 {
50  return "WORHP";
51 }
52 
53 /** gets string that describes Worhp (version number) */
54 const char* SCIPgetSolverDescWorhp(void)
55 {
56  return "this is WORHP";
57 }
58 
59 /** returns whether Worhp is available, i.e., whether it has been linked in */
61 {
62  return FALSE;
63 }
#define NULL
Definition: def.h:267
SCIP_RETCODE SCIPincludeNlpSolverWorhp(SCIP *scip, SCIP_Bool useip)
const char * SCIPgetSolverDescWorhp(void)
#define FALSE
Definition: def.h:94
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:63
Worhp NLP interface.
SCIP_Bool SCIPisWorhpAvailableWorhp(void)
#define SCIP_Bool
Definition: def.h:91
const char * SCIPgetSolverNameWorhp(void)