objiisfinder.cpp File Reference

Detailed Description

C++ wrapper for IIS finders.

Author

Mark Turner

Definition in file objiisfinder.cpp.

#include <cassert>
#include "objiisfinder.h"

Go to the source code of this file.

Functions
static	SCIP_DECL_IISFINDERCOPY (iisfinderCopyObj)
static	SCIP_DECL_IISFINDERFREE (iisfinderFreeObj)
static	SCIP_DECL_IISFINDEREXEC (iisfinderExecObj)
SCIP_RETCODE	SCIPincludeObjIISfinder (SCIP *scip, scip::ObjIISfinder *objiisfinder, SCIP_Bool deleteobject)
scip::ObjIISfinder *	SCIPfindObjIISfinder (SCIP *scip, const char *name)
scip::ObjIISfinder *	SCIPgetObjIISfinder (SCIP *scip, SCIP_IISFINDER *iisfinder)

Function Documentation

SCIP_DECL_IISFINDERCOPY()

SCIP_DECL_IISFINDERCOPY ( iisfinderCopyObj )

static

copy method for iis finder plugins (called when SCIP copies plugins)

Definition at line 56 of file objiisfinder.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPiisfinderGetData(), SCIPincludeObjIISfinder(), and TRUE.

SCIP_DECL_IISFINDERFREE()

SCIP_DECL_IISFINDERFREE ( iisfinderFreeObj )

static

destructor of iis finder to free user data (called when SCIP is exiting)

Definition at line 81 of file objiisfinder.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPiisfinderGetData(), and SCIPiisfinderSetData().

SCIP_DECL_IISFINDEREXEC()

SCIP_DECL_IISFINDEREXEC ( iisfinderExecObj )

static

iis finder execution method of iisfinder

Definition at line 106 of file objiisfinder.cpp.

References assert(), NULL, result, SCIP_CALL, SCIP_OKAY, and SCIPiisfinderGetData().

SCIPincludeObjIISfinder()

SCIP_RETCODE SCIPincludeObjIISfinder	(	SCIP *	scip,
		scip::ObjIISfinder *	objiisfinder,
		SCIP_Bool	deleteobject )

creates the iis finder for the given iis finder object and includes it in SCIP

creates the iis finder for the given iis finder object and includes it in SCIP

The method should be called in one of the following ways:

1. The user is responsible for deleting the object: SCIP_CALL( SCIPcreate(&scip) ); ... MyIISfinder* myiisfinder = new MyIISfinder(...); SCIP_CALL( SCIPincludeObjIISfinder(scip, &myiisfinder, FALSE) ); ... SCIP_CALL( SCIPfree(&scip) ); delete myiisfinder; // delete iisfinder AFTER SCIPfree() !
2. The object pointer is passed to SCIP and deleted by SCIP in the SCIPfree() call: SCIP_CALL( SCIPcreate(&scip) ); ... SCIP_CALL( SCIPincludeObjIISfinder(scip, new MyIISfinder(...), TRUE) ); ... SCIP_CALL( SCIPfree(&scip) ); // destructor of MyIISfinder is called here

Parameters

scip	SCIP data structure
objiisfinder	iis finder object
deleteobject	should the iis finder object be deleted when iis finder is freed?

Definition at line 126 of file objiisfinder.cpp.

References assert(), NULL, SCIP_Bool, SCIP_CALL, scip::ObjIISfinder::scip_desc_, scip::ObjIISfinder::scip_name_, SCIP_OKAY, scip::ObjIISfinder::scip_priority_, and SCIPincludeIISfinder().

Referenced by SCIP_DECL_IISFINDERCOPY().

SCIPfindObjIISfinder()

scip::ObjIISfinder * SCIPfindObjIISfinder	(	SCIP *	scip,
		const char *	name )

returns the iis finder object of the given name, or 0 if not existing

Parameters

scip	SCIP data structure
name	name of iis finder

Definition at line 154 of file objiisfinder.cpp.

References assert(), NULL, SCIPfindIISfinder(), and SCIPiisfinderGetData().

SCIPgetObjIISfinder()

scip::ObjIISfinder * SCIPgetObjIISfinder	(	SCIP *	scip,
		SCIP_IISFINDER *	iisfinder )

returns the iis finder object for the given iis finder

Parameters

scip	SCIP data structure
iisfinder	iis finder

Definition at line 173 of file objiisfinder.cpp.

References assert(), NULL, and SCIPiisfinderGetData().