Scippy

SCIP

Solving Constraint Integer Programs

type_sol.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 type_sol.h
26  * @brief type definitions for storing primal CIP solutions
27  * @author Tobias Achterberg
28  */
29 
30 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
31 
32 #ifndef __SCIP_TYPE_SOL_H__
33 #define __SCIP_TYPE_SOL_H__
34 
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38 
39 /** origin of solution: where to retrieve uncached elements */
41 {
42  SCIP_SOLORIGIN_ORIGINAL = 0, /**< solution describes original variables; non-cached elements are zero */
43  SCIP_SOLORIGIN_ZERO = 1, /**< all non-cached elements in solution are equal to zero */
44  SCIP_SOLORIGIN_LPSOL = 2, /**< all non-cached elements in solution are equal to current LP solution */
45  SCIP_SOLORIGIN_NLPSOL = 3, /**< all non-cached elements in solution are equal to current NLP solution */
46  SCIP_SOLORIGIN_RELAXSOL = 4, /**< all non-cached elements in solution are equal to current relaxation solution */
47  SCIP_SOLORIGIN_PSEUDOSOL = 5, /**< all non-cached elements in solution are equal to current pseudo solution */
48  SCIP_SOLORIGIN_PARTIAL = 6, /**< solution describes original solution; all non-cached elements in solution
49  * are treated as being an arbitrary value in the variable's bounds
50  */
51  SCIP_SOLORIGIN_UNKNOWN = 7 /**< all non-cached elements in solution are unknown; they have to be treated
52  * as being an arbitrary value in the variable's bounds
53  */
54 };
56 
57 typedef struct SCIP_Sol SCIP_SOL; /**< primal CIP solution */
58 
59 typedef struct SCIP_Viol SCIP_VIOL; /**< maximum violations of problem constraints */
60 
61 /** type of solution: heuristic or (LP) relaxation solution, or unspecified origin */
63 {
64  SCIP_SOLTYPE_UNKNOWN = 0, /**< type of solution unspecified (the default) */
65  SCIP_SOLTYPE_HEUR = 1, /**< solution was found by a heuristic */
66  SCIP_SOLTYPE_RELAX = 2, /**< solution was found by a relaxation */
67  SCIP_SOLTYPE_LPRELAX = 3, /**< solution was found by the LP relaxation */
68  SCIP_SOLTYPE_STRONGBRANCH = 4, /**< solution was found during strong branching */
69  SCIP_SOLTYPE_PSEUDO = 5 /**< solution originates from a pseudo solution */
70 };
72 
73 #ifdef __cplusplus
74 }
75 #endif
76 
77 #endif
SCIP_SolOrigin
Definition: type_sol.h:40
SCIP_SolType
Definition: type_sol.h:62
enum SCIP_SolType SCIP_SOLTYPE
Definition: type_sol.h:71
enum SCIP_SolOrigin SCIP_SOLORIGIN
Definition: type_sol.h:55