Scippy

SCIP

Solving Constraint Integer Programs

Public Member Functions | Data Fields
scip::ObjSepa Class Reference

Detailed Description

C++ wrapper for cut separators.

This class defines the interface for cut separators implemented in C++.

Definition at line 42 of file objsepa.h.

C++ wrapper for cut separators. More...

#include <objsepa.h>

Public Member Functions

 ObjSepa (SCIP *scip, const char *name, const char *desc, int priority, int freq, SCIP_Real maxbounddist, SCIP_Bool usessubscip, SCIP_Bool delay)
 
virtual ~ObjSepa ()
 
virtual SCIP_DECL_SEPAFREE (scip_free)
 
virtual SCIP_DECL_SEPAINIT (scip_init)
 
virtual SCIP_DECL_SEPAEXIT (scip_exit)
 
virtual SCIP_DECL_SEPAINITSOL (scip_initsol)
 
virtual SCIP_DECL_SEPAEXITSOL (scip_exitsol)
 
virtual SCIP_DECL_SEPAEXECLP (scip_execlp)
 
virtual SCIP_DECL_SEPAEXECSOL (scip_execsol)
 
- Public Member Functions inherited from scip::ObjCloneable
virtual ~ObjCloneable ()
 
virtual SCIP_DECL_OBJCLONEABLECLONE (ObjCloneable *clone)
 
virtual SCIP_DECL_OBJCLONEABLEISCLONEABLE (iscloneable)
 

Data Fields

SCIP * scip_
 
char * scip_name_
 
char * scip_desc_
 
const int scip_priority_
 
const int scip_freq_
 
const SCIP_Real scip_maxbounddist_
 
const SCIP_Bool scip_usessubscip_
 
const SCIP_Bool scip_delay_
 

Constructor & Destructor Documentation

◆ ObjSepa()

scip::ObjSepa::ObjSepa ( SCIP *  scip,
const char *  name,
const char *  desc,
int  priority,
int  freq,
SCIP_Real  maxbounddist,
SCIP_Bool  usessubscip,
SCIP_Bool  delay 
)
inline

default constructor

Parameters
scipSCIP data structure
namename of cut separator
descdescription of cut separator
prioritypriority of the cut separator
freqfrequency for calling separator
maxbounddistmaximal relative distance from current node's dual bound to primal bound compared to best node's dual bound for applying separation
usessubscipdoes the separator use a secondary SCIP instance?
delayshould separator be delayed, if other separators found cuts?

Definition at line 74 of file objsepa.h.

References SCIP_CALL_ABORT, and SCIPduplicateMemoryArray.

◆ ~ObjSepa()

virtual scip::ObjSepa::~ObjSepa ( )
inlinevirtual

destructor

Definition at line 100 of file objsepa.h.

References SCIPfreeMemoryArray.

Member Function Documentation

◆ SCIP_DECL_SEPAFREE()

virtual scip::ObjSepa::SCIP_DECL_SEPAFREE ( scip_free  )
inlinevirtual

destructor of cut separator to free user data (called when SCIP is exiting)

See also
SCIP_DECL_SEPAFREE(x) in type_sepa.h

Definition at line 112 of file objsepa.h.

References SCIP_OKAY.

◆ SCIP_DECL_SEPAINIT()

virtual scip::ObjSepa::SCIP_DECL_SEPAINIT ( scip_init  )
inlinevirtual

initialization method of cut separator (called after problem was transformed)

See also
SCIP_DECL_SEPAINIT(x) in type_sepa.h

Definition at line 121 of file objsepa.h.

References SCIP_OKAY.

◆ SCIP_DECL_SEPAEXIT()

virtual scip::ObjSepa::SCIP_DECL_SEPAEXIT ( scip_exit  )
inlinevirtual

deinitialization method of cut separator (called before transformed problem is freed)

See also
SCIP_DECL_SEPAEXIT(x) in type_sepa.h

Definition at line 130 of file objsepa.h.

References SCIP_OKAY.

◆ SCIP_DECL_SEPAINITSOL()

virtual scip::ObjSepa::SCIP_DECL_SEPAINITSOL ( scip_initsol  )
inlinevirtual

solving process initialization method of separator (called when branch and bound process is about to begin)

See also
SCIP_DECL_SEPAINITSOL(x) in type_sepa.h

Definition at line 139 of file objsepa.h.

References SCIP_OKAY.

◆ SCIP_DECL_SEPAEXITSOL()

virtual scip::ObjSepa::SCIP_DECL_SEPAEXITSOL ( scip_exitsol  )
inlinevirtual

solving process deinitialization method of separator (called before branch and bound process data is freed)

See also
SCIP_DECL_SEPAEXITSOL(x) in type_sepa.h

Definition at line 148 of file objsepa.h.

References SCIP_OKAY.

◆ SCIP_DECL_SEPAEXECLP()

virtual scip::ObjSepa::SCIP_DECL_SEPAEXECLP ( scip_execlp  )
inlinevirtual

LP solution separation method of separator

See also
SCIP_DECL_SEPAEXECLP(x) in type_sepa.h

Definition at line 157 of file objsepa.h.

References NULL, SCIP_DIDNOTRUN, and SCIP_OKAY.

◆ SCIP_DECL_SEPAEXECSOL()

virtual scip::ObjSepa::SCIP_DECL_SEPAEXECSOL ( scip_execsol  )
inlinevirtual

arbitrary primal solution separation method of separator

See also
SCIP_DECL_SEPAEXECSOL(x) in type_sepa.h

Definition at line 168 of file objsepa.h.

References NULL, SCIP_Bool, SCIP_DIDNOTRUN, SCIP_EXPORT, SCIP_OKAY, SCIPfindObjSepa(), SCIPgetObjSepa(), and SCIPincludeObjSepa().

Field Documentation

◆ scip_

SCIP* scip::ObjSepa::scip_

SCIP data structure

Definition at line 48 of file objsepa.h.

◆ scip_name_

char* scip::ObjSepa::scip_name_

name of the cut separator

Definition at line 51 of file objsepa.h.

Referenced by SCIPincludeObjSepa().

◆ scip_desc_

char* scip::ObjSepa::scip_desc_

description of the cut separator

Definition at line 54 of file objsepa.h.

Referenced by SCIPincludeObjSepa().

◆ scip_priority_

const int scip::ObjSepa::scip_priority_

default priority of the cut separator

Definition at line 57 of file objsepa.h.

Referenced by SCIPincludeObjSepa().

◆ scip_freq_

const int scip::ObjSepa::scip_freq_

frequency for calling separator

Definition at line 60 of file objsepa.h.

Referenced by SCIPincludeObjSepa().

◆ scip_maxbounddist_

const SCIP_Real scip::ObjSepa::scip_maxbounddist_

maximal relative distance from current node's dual bound to primal bound compared to best node's dual bound for applying separation (0.0: only on current best node, 1.0: on all nodes)

Definition at line 65 of file objsepa.h.

Referenced by SCIPincludeObjSepa().

◆ scip_usessubscip_

const SCIP_Bool scip::ObjSepa::scip_usessubscip_

does the separator use a secondary SCIP instance?

Definition at line 68 of file objsepa.h.

Referenced by SCIPincludeObjSepa().

◆ scip_delay_

const SCIP_Bool scip::ObjSepa::scip_delay_

should separator be delayed, if other separators found cuts?

Definition at line 71 of file objsepa.h.

Referenced by SCIPincludeObjSepa().