Scippy

SCIP

Solving Constraint Integer Programs

type_paramset.h File Reference

Detailed Description

type definitions for handling parameter settings

Author
Tobias Achterberg

Definition in file type_paramset.h.

#include "scip/def.h"
#include "scip/type_retcode.h"
#include "scip/type_scip.h"

Go to the source code of this file.

Macros

#define SCIP_DECL_PARAMCHGD(x)   SCIP_RETCODE x (SCIP* scip, SCIP_PARAM* param)
 

Typedefs

typedef enum SCIP_ParamType SCIP_PARAMTYPE
 
typedef enum SCIP_ParamSetting SCIP_PARAMSETTING
 
typedef enum SCIP_ParamEmphasis SCIP_PARAMEMPHASIS
 
typedef struct SCIP_Param SCIP_PARAM
 
typedef struct SCIP_ParamData SCIP_PARAMDATA
 
typedef struct SCIP_ParamSet SCIP_PARAMSET
 

Enumerations

enum  SCIP_ParamType {
  SCIP_PARAMTYPE_BOOL = 0,
  SCIP_PARAMTYPE_INT = 1,
  SCIP_PARAMTYPE_LONGINT = 2,
  SCIP_PARAMTYPE_REAL = 3,
  SCIP_PARAMTYPE_CHAR = 4,
  SCIP_PARAMTYPE_STRING = 5
}
 
enum  SCIP_ParamSetting {
  SCIP_PARAMSETTING_DEFAULT = 0,
  SCIP_PARAMSETTING_AGGRESSIVE = 1,
  SCIP_PARAMSETTING_FAST = 2,
  SCIP_PARAMSETTING_OFF = 3
}
 
enum  SCIP_ParamEmphasis {
  SCIP_PARAMEMPHASIS_DEFAULT = 0,
  SCIP_PARAMEMPHASIS_CPSOLVER = 1,
  SCIP_PARAMEMPHASIS_EASYCIP = 2,
  SCIP_PARAMEMPHASIS_FEASIBILITY = 3,
  SCIP_PARAMEMPHASIS_HARDLP = 4,
  SCIP_PARAMEMPHASIS_OPTIMALITY = 5,
  SCIP_PARAMEMPHASIS_COUNTER = 6,
  SCIP_PARAMEMPHASIS_PHASEFEAS = 7,
  SCIP_PARAMEMPHASIS_PHASEIMPROVE = 8,
  SCIP_PARAMEMPHASIS_PHASEPROOF = 9,
  SCIP_PARAMEMPHASIS_NUMERICS = 10
}
 

Macro Definition Documentation

◆ SCIP_DECL_PARAMCHGD

#define SCIP_DECL_PARAMCHGD (   x)    SCIP_RETCODE x (SCIP* scip, SCIP_PARAM* param)

information method for changes in the parameter

Method is called if the parameter was changed through a SCIPparamsetSetXyz() call (which is called by SCIPsetXyzParam()). It will not be called, if the parameter was changed directly by changing the value in the memory location.

input: scip : SCIP main data structure param : the changed parameter (already set to its new value)

Definition at line 92 of file type_paramset.h.

Typedef Documentation

◆ SCIP_PARAMTYPE

Definition at line 45 of file type_paramset.h.

◆ SCIP_PARAMSETTING

Definition at line 56 of file type_paramset.h.

◆ SCIP_PARAMEMPHASIS

Definition at line 74 of file type_paramset.h.

◆ SCIP_PARAM

typedef struct SCIP_Param SCIP_PARAM

single parameter

Definition at line 76 of file type_paramset.h.

◆ SCIP_PARAMDATA

typedef struct SCIP_ParamData SCIP_PARAMDATA

locally defined parameter specific data

Definition at line 77 of file type_paramset.h.

◆ SCIP_PARAMSET

typedef struct SCIP_ParamSet SCIP_PARAMSET

set of parameters

Definition at line 78 of file type_paramset.h.

Enumeration Type Documentation

◆ SCIP_ParamType

possible parameter types

Enumerator
SCIP_PARAMTYPE_BOOL 

bool values: TRUE or FALSE

SCIP_PARAMTYPE_INT 

integer values

SCIP_PARAMTYPE_LONGINT 

long integer values

SCIP_PARAMTYPE_REAL 

real values

SCIP_PARAMTYPE_CHAR 

characters

SCIP_PARAMTYPE_STRING 

strings: arrays of characters

Definition at line 36 of file type_paramset.h.

◆ SCIP_ParamSetting

possible parameter settings - used to determine the behavior of different SCIP components, e.g., heuristics, separators, ...

Enumerator
SCIP_PARAMSETTING_DEFAULT 

use default values

SCIP_PARAMSETTING_AGGRESSIVE 

set to aggressive settings

SCIP_PARAMSETTING_FAST 

set to fast settings

SCIP_PARAMSETTING_OFF 

turn off

Definition at line 48 of file type_paramset.h.

◆ SCIP_ParamEmphasis

possible parameter emphases - used to determine the general SCIP behavior

Enumerator
SCIP_PARAMEMPHASIS_DEFAULT 

use default values

SCIP_PARAMEMPHASIS_CPSOLVER 

get CP like search (e.g. no LP relaxation)

SCIP_PARAMEMPHASIS_EASYCIP 

solve easy problems fast

SCIP_PARAMEMPHASIS_FEASIBILITY 

detect feasibility fast

SCIP_PARAMEMPHASIS_HARDLP 

be capable to handle hard LPs

SCIP_PARAMEMPHASIS_OPTIMALITY 

prove optimality fast

SCIP_PARAMEMPHASIS_COUNTER 

get a feasible and "fast" counting process

SCIP_PARAMEMPHASIS_PHASEFEAS 

feasibility phase settings during 3-phase solving approach

SCIP_PARAMEMPHASIS_PHASEIMPROVE 

improvement phase settings during 3-phase solving approach

SCIP_PARAMEMPHASIS_PHASEPROOF 

proof phase settings during 3-phase solving approach

SCIP_PARAMEMPHASIS_NUMERICS 

emphasis parameters for increased numerical safety

Definition at line 59 of file type_paramset.h.