SCIP Doxygen Documentation
Loading...
Searching...
No Matches
objpricer.cpp File Reference

Detailed Description

C++ wrapper for variable pricers.

Author
Tobias Achterberg

Definition in file objpricer.cpp.

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

Go to the source code of this file.

Functions

static SCIP_DECL_PRICERCOPY (pricerCopyObj)
static SCIP_DECL_PRICERFREE (pricerFreeObj)
static SCIP_DECL_PRICERINIT (pricerInitObj)
static SCIP_DECL_PRICEREXIT (pricerExitObj)
static SCIP_DECL_PRICERINITSOL (pricerInitsolObj)
static SCIP_DECL_PRICEREXITSOL (pricerExitsolObj)
static SCIP_DECL_PRICERREDCOST (pricerRedcostObj)
static SCIP_DECL_PRICERFARKAS (pricerFarkasObj)
SCIP_RETCODE SCIPincludeObjPricer (SCIP *scip, scip::ObjPricer *objpricer, SCIP_Bool deleteobject)
scip::ObjPricer * SCIPfindObjPricer (SCIP *scip, const char *name)
scip::ObjPricer * SCIPgetObjPricer (SCIP *scip, SCIP_PRICER *pricer)

Function Documentation

◆ SCIP_DECL_PRICERCOPY()

SCIP_DECL_PRICERCOPY ( pricerCopyObj )
static

copy method for pricer plugins (called when SCIP copies plugins)

Definition at line 62 of file objpricer.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPincludeObjPricer(), SCIPpricerGetData(), TRUE, and valid.

◆ SCIP_DECL_PRICERFREE()

SCIP_DECL_PRICERFREE ( pricerFreeObj )
static

destructor of variable pricer to free user data (called when SCIP is exiting)

Definition at line 87 of file objpricer.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, SCIPpricerGetData(), and SCIPpricerSetData().

◆ SCIP_DECL_PRICERINIT()

SCIP_DECL_PRICERINIT ( pricerInitObj )
static

initialization method of variable pricer (called after problem was transformed)

Definition at line 113 of file objpricer.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPpricerGetData().

◆ SCIP_DECL_PRICEREXIT()

SCIP_DECL_PRICEREXIT ( pricerExitObj )
static

deinitialization method of variable pricer (called before transformed problem is freed)

Definition at line 131 of file objpricer.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPpricerGetData().

◆ SCIP_DECL_PRICERINITSOL()

SCIP_DECL_PRICERINITSOL ( pricerInitsolObj )
static

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

Definition at line 148 of file objpricer.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPpricerGetData().

◆ SCIP_DECL_PRICEREXITSOL()

SCIP_DECL_PRICEREXITSOL ( pricerExitsolObj )
static

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

Definition at line 165 of file objpricer.cpp.

References assert(), NULL, SCIP_CALL, SCIP_OKAY, and SCIPpricerGetData().

◆ SCIP_DECL_PRICERREDCOST()

SCIP_DECL_PRICERREDCOST ( pricerRedcostObj )
static

reduced cost pricing method of variable pricer for feasible LPs

Definition at line 182 of file objpricer.cpp.

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

◆ SCIP_DECL_PRICERFARKAS()

SCIP_DECL_PRICERFARKAS ( pricerFarkasObj )
static

farkas pricing method of variable pricer for infeasible LPs

Definition at line 199 of file objpricer.cpp.

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

◆ SCIPincludeObjPricer()

SCIP_RETCODE SCIPincludeObjPricer ( SCIP * scip,
scip::ObjPricer * objpricer,
SCIP_Bool deleteobject )

creates the variable pricer for the given variable pricer object and includes it in SCIP

creates the variable pricer for the given variable pricer object and includes it in SCIP

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

  1. The user is responsible of deleting the object: SCIP_CALL( SCIPcreate(&scip) ); ... MyPricer* mypricer = new MyPricer(...); SCIP_CALL( SCIPincludeObjPricer(scip, &mypricer, FALSE) ); ... SCIP_CALL( SCIPfree(&scip) ); delete mypricer; // delete pricer AFTER SCIPfree() !
  2. The object pointer is passed to SCIP and deleted by SCIP in the SCIPfree() call: SCIP_CALL( SCIPcreate(&scip) ); ... SCIP_CALL( SCIPincludeObjPricer(scip, new MyPricer(...), TRUE) ); ... SCIP_CALL( SCIPfree(&scip) ); // destructor of MyPricer is called here
Parameters
scipSCIP data structure
objpricervariable pricer object
deleteobjectshould the pricer object be deleted when pricer is freed?

Definition at line 221 of file objpricer.cpp.

References assert(), NULL, SCIP_Bool, SCIP_CALL, scip::ObjPricer::scip_delay_, scip::ObjPricer::scip_desc_, scip::ObjPricer::scip_name_, SCIP_OKAY, scip::ObjPricer::scip_priority_, and SCIPincludePricer().

Referenced by execmain(), and SCIP_DECL_PRICERCOPY().

◆ SCIPfindObjPricer()

scip::ObjPricer * SCIPfindObjPricer ( SCIP * scip,
const char * name )

returns the variable pricer object of the given name, or 0 if not existing

Parameters
scipSCIP data structure
namename of variable pricer

Definition at line 249 of file objpricer.cpp.

References assert(), NULL, SCIPfindPricer(), and SCIPpricerGetData().

◆ SCIPgetObjPricer()

scip::ObjPricer * SCIPgetObjPricer ( SCIP * scip,
SCIP_PRICER * pricer )

returns the variable pricer object for the given pricer

Parameters
scipSCIP data structure
pricerpricer

Definition at line 268 of file objpricer.cpp.

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