Scippy

    SCIP

    Solving Constraint Integer Programs

    objiisfinder.h File Reference

    Detailed Description

    C++ wrapper for iis finders.

    Author
    Mark Turner

    Definition in file objiisfinder.h.

    #include <cstring>
    #include <utility>
    #include "scip/scip.h"
    #include "objscip/objcloneable.h"

    Go to the source code of this file.

    Data Structures

    class  scip::ObjIISfinder
     C++ wrapper for iis finders. More...
     

    Namespaces

    namespace  scip
     

    Functions

    SCIP_RETCODE SCIPincludeObjIISfinder (SCIP *scip, scip::ObjIISfinder *objiisfinder, SCIP_Bool deleteobject)
     
    scip::ObjIISfinderSCIPfindObjIISfinder (SCIP *scip, const char *name)
     
    scip::ObjIISfinderSCIPgetObjIISfinder (SCIP *scip, SCIP_IISFINDER *iisfinder)
     

    Function Documentation

    ◆ 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

    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

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

    Parameters
    scipSCIP data structure
    objiisfinderiis finder object
    deleteobjectshould the iis finder object be deleted when iis finder is freed?

    Definition at line 126 of file objiisfinder.cpp.

    References NULL, 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
    scipSCIP data structure
    namename of iis finder

    Definition at line 154 of file objiisfinder.cpp.

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

    ◆ SCIPgetObjIISfinder()

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

    returns the iis finder object for the given iis finder

    Parameters
    scipSCIP data structure
    iisfinderiis finder

    Definition at line 173 of file objiisfinder.cpp.

    References NULL, and SCIPiisfinderGetData().