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_paramset.h
26   	 * @ingroup TYPEDEFINITIONS
27   	 * @brief  type definitions for handling parameter settings
28   	 * @author Tobias Achterberg
29   	 */
30   	
31   	/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
32   	
33   	#ifndef __SCIP_TYPE_PARAMSET_H__
34   	#define __SCIP_TYPE_PARAMSET_H__
35   	
36   	#include "scip/def.h"
37   	#include "scip/type_retcode.h"
38   	#include "scip/type_scip.h"
39   	
40   	#ifdef __cplusplus
41   	extern "C" {
42   	#endif
43   	
44   	/** possible parameter types */
45   	enum SCIP_ParamType
46   	{
47   	   SCIP_PARAMTYPE_BOOL    = 0,               /**< bool values: TRUE or FALSE */
48   	   SCIP_PARAMTYPE_INT     = 1,               /**< integer values */
49   	   SCIP_PARAMTYPE_LONGINT = 2,               /**< long integer values */
50   	   SCIP_PARAMTYPE_REAL    = 3,               /**< real values */
51   	   SCIP_PARAMTYPE_CHAR    = 4,               /**< characters */
52   	   SCIP_PARAMTYPE_STRING  = 5                /**< strings: arrays of characters */
53   	};
54   	typedef enum SCIP_ParamType SCIP_PARAMTYPE;
55   	
56   	/** possible parameter settings - used to determine the behavior of different SCIP components, e.g., heuristics, separators, ... */
57   	enum SCIP_ParamSetting
58   	{
59   	   SCIP_PARAMSETTING_DEFAULT     = 0,        /**< use default values */
60   	
61   	   SCIP_PARAMSETTING_AGGRESSIVE  = 1,        /**< set to aggressive settings */
62   	   SCIP_PARAMSETTING_FAST        = 2,        /**< set to fast settings */
63   	   SCIP_PARAMSETTING_OFF         = 3         /**< turn off */
64   	};
65   	typedef enum SCIP_ParamSetting SCIP_PARAMSETTING;
66   	
67   	/** possible parameter emphases - used to determine the general SCIP behavior */
68   	enum SCIP_ParamEmphasis
69   	{
70   	   SCIP_PARAMEMPHASIS_DEFAULT     = 0,        /**< use default values */
71   	
72   	   SCIP_PARAMEMPHASIS_CPSOLVER    = 1,        /**< get CP like search (e.g. no LP relaxation) */
73   	   SCIP_PARAMEMPHASIS_EASYCIP     = 2,        /**< solve easy problems fast */
74   	   SCIP_PARAMEMPHASIS_FEASIBILITY = 3,        /**< detect feasibility fast */
75   	   SCIP_PARAMEMPHASIS_HARDLP      = 4,        /**< be capable to handle hard LPs */
76   	   SCIP_PARAMEMPHASIS_OPTIMALITY  = 5,        /**< prove optimality fast */
77   	   SCIP_PARAMEMPHASIS_COUNTER     = 6,        /**< get a feasible and "fast" counting process */
78   	   SCIP_PARAMEMPHASIS_PHASEFEAS   = 7,        /**< feasibility phase settings during 3-phase solving approach */
79   	   SCIP_PARAMEMPHASIS_PHASEIMPROVE= 8,        /**< improvement phase settings during 3-phase solving approach */
80   	   SCIP_PARAMEMPHASIS_PHASEPROOF  = 9,        /**< proof phase settings during 3-phase solving approach */
81   	   SCIP_PARAMEMPHASIS_NUMERICS    = 10,       /**< emphasis parameters for increased numerical safety */
82   	   SCIP_PARAMEMPHASIS_BENCHMARK   = 11        /**< do not try to avoid running into memory limit */
83   	};
84   	typedef enum SCIP_ParamEmphasis SCIP_PARAMEMPHASIS;
85   	
86   	typedef struct SCIP_Param SCIP_PARAM;             /**< single parameter */
87   	typedef struct SCIP_ParamData SCIP_PARAMDATA;     /**< locally defined parameter specific data */
88   	typedef struct SCIP_ParamSet SCIP_PARAMSET;       /**< set of parameters */
89   	
90   	
91   	/** information method for changes in the parameter
92   	 *
93   	 *  Method is called if the parameter was changed through a SCIPparamsetSetXyz() call
94   	 *  (which is called by SCIPsetXyzParam()).
95   	 *  It will not be called, if the parameter was changed directly by changing the value
96   	 *  in the memory location.
97   	 *
98   	 *  input:
99   	 *    scip            : SCIP main data structure
100  	 *    param           : the changed parameter (already set to its new value)
101  	 */
102  	#define SCIP_DECL_PARAMCHGD(x) SCIP_RETCODE x (SCIP* scip, SCIP_PARAM* param)
103  	
104  	#ifdef __cplusplus
105  	}
106  	#endif
107  	
108  	#endif
109