Scippy

    SCIP

    Solving Constraint Integer Programs

    Public Member Functions | Data Fields
    scip::ObjNodesel Class Referenceabstract

    Detailed Description

    C++ wrapper for node selectors.

    This class defines the interface for node selectors implemented in C++. Note that there is a pure virtual function (this function has to be implemented). This function is: scip_comp().

    Definition at line 53 of file objnodesel.h.

    C++ wrapper for node selectors. More...

    #include <objnodesel.h>

    Public Member Functions

     ObjNodesel (SCIP *scip, const char *name, const char *desc, int stdpriority, int memsavepriority)
     
     ObjNodesel (const ObjNodesel &o)
     
     ObjNodesel (ObjNodesel &&o)
     
    virtual ~ObjNodesel ()
     
    ObjNodesel & operator= (const ObjNodesel &o)=delete
     
    ObjNodesel & operator= (ObjNodesel &&o)=delete
     
    virtual SCIP_DECL_NODESELFREE (scip_free)
     
    virtual SCIP_DECL_NODESELINIT (scip_init)
     
    virtual SCIP_DECL_NODESELEXIT (scip_exit)
     
    virtual SCIP_DECL_NODESELINITSOL (scip_initsol)
     
    virtual SCIP_DECL_NODESELEXITSOL (scip_exitsol)
     
    virtual SCIP_DECL_NODESELSELECT (scip_select)=0
     
    virtual SCIP_DECL_NODESELCOMP (scip_comp)=0
     
    - Public Member Functions inherited from scip::ObjCloneable
    virtual ~ObjCloneable ()
     
    ObjCloneable & operator= (const ObjCloneable &o)=delete
     
    ObjCloneable & operator= (ObjCloneable &&o)=delete
     
    virtual SCIP_DECL_OBJCLONEABLECLONE (ObjCloneable *clone)
     
    virtual SCIP_DECL_OBJCLONEABLEISCLONEABLE (iscloneable)
     

    Data Fields

    SCIP * scip_
     
    char * scip_name_
     
    char * scip_desc_
     
    const int scip_stdpriority_
     
    const int scip_memsavepriority_
     

    Constructor & Destructor Documentation

    ◆ ObjNodesel() [1/3]

    scip::ObjNodesel::ObjNodesel ( SCIP *  scip,
    const char *  name,
    const char *  desc,
    int  stdpriority,
    int  memsavepriority 
    )
    		inline

    default constructor

    Parameters
    scipSCIP data structure
    namename of node selector
    descdescription of node selector
    stdprioritypriority of the node selector in standard mode
    memsaveprioritypriority of the node selector in memory saving mode

    Definition at line 74 of file objnodesel.h.

    References scip_, SCIP_CALL_ABORT, scip_desc_, scip_name_, and SCIPduplicateMemoryArray.

    ◆ ObjNodesel() [2/3]

    scip::ObjNodesel::ObjNodesel ( const ObjNodesel &  o)
    		inline

    copy constructor

    Definition at line 93 of file objnodesel.h.

    ◆ ObjNodesel() [3/3]

    scip::ObjNodesel::ObjNodesel ( ObjNodesel &&  o)
    		inline

    move constructor

    Definition at line 99 of file objnodesel.h.

    References scip_desc_, and scip_name_.

    ◆ ~ObjNodesel()

    virtual scip::ObjNodesel::~ObjNodesel ( )
    		inlinevirtual

    destructor

    Definition at line 111 of file objnodesel.h.

    References scip_, scip_desc_, scip_name_, and SCIPfreeMemoryArray.

    Member Function Documentation

    ◆ operator=() [1/2]

    ObjNodesel & scip::ObjNodesel::operator= ( const ObjNodesel &  o)
    		delete

    assignment of polymorphic classes causes slicing and is therefore disabled.

    ◆ operator=() [2/2]

    ObjNodesel & scip::ObjNodesel::operator= ( ObjNodesel &&  o)
    		delete

    assignment of polymorphic classes causes slicing and is therefore disabled.

    ◆ SCIP_DECL_NODESELFREE()

    virtual scip::ObjNodesel::SCIP_DECL_NODESELFREE ( scip_free  )
    		inlinevirtual

    destructor of node selector to free user data (called when SCIP is exiting)

    See also
    SCIP_DECL_NODESELFREE(x) in type_nodesel.h

    Definition at line 129 of file objnodesel.h.

    References SCIP_OKAY.

    ◆ SCIP_DECL_NODESELINIT()

    virtual scip::ObjNodesel::SCIP_DECL_NODESELINIT ( scip_init  )
    		inlinevirtual

    initialization method of node selector (called after problem was transformed)

    See also
    SCIP_DECL_NODESELINIT(x) in type_nodesel.h

    Definition at line 138 of file objnodesel.h.

    References SCIP_OKAY.

    ◆ SCIP_DECL_NODESELEXIT()

    virtual scip::ObjNodesel::SCIP_DECL_NODESELEXIT ( scip_exit  )
    		inlinevirtual

    deinitialization method of node selector (called before transformed problem is freed)

    See also
    SCIP_DECL_NODESELEXIT(x) in type_nodesel.h

    Definition at line 147 of file objnodesel.h.

    References SCIP_OKAY.

    ◆ SCIP_DECL_NODESELINITSOL()

    virtual scip::ObjNodesel::SCIP_DECL_NODESELINITSOL ( scip_initsol  )
    		inlinevirtual

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

    See also
    SCIP_DECL_NODESELINITSOL(x) in type_nodesel.h

    Definition at line 156 of file objnodesel.h.

    References SCIP_OKAY.

    ◆ SCIP_DECL_NODESELEXITSOL()

    virtual scip::ObjNodesel::SCIP_DECL_NODESELEXITSOL ( scip_exitsol  )
    		inlinevirtual

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

    See also
    SCIP_DECL_NODESELEXITSOL(x) in type_nodesel.h

    Definition at line 165 of file objnodesel.h.

    References SCIP_OKAY.

    ◆ SCIP_DECL_NODESELSELECT()

    virtual scip::ObjNodesel::SCIP_DECL_NODESELSELECT ( scip_select  )
    		pure virtual

    node selection method of node selector

    See also
    SCIP_DECL_NODESELSELECT(x) in type_nodesel.h

    ◆ SCIP_DECL_NODESELCOMP()

    virtual scip::ObjNodesel::SCIP_DECL_NODESELCOMP ( scip_comp  )
    		pure virtual

    node comparison method of node selector

    See also
    SCIP_DECL_NODESELCOMP(x) in type_nodesel.h

    Field Documentation

    ◆ scip_

    SCIP* scip::ObjNodesel::scip_

    SCIP data structure

    Definition at line 59 of file objnodesel.h.

    Referenced by ObjNodesel(), and ~ObjNodesel().

    ◆ scip_name_

    char* scip::ObjNodesel::scip_name_

    name of the node selector

    Definition at line 62 of file objnodesel.h.

    Referenced by ObjNodesel(), SCIPincludeObjNodesel(), and ~ObjNodesel().

    ◆ scip_desc_

    char* scip::ObjNodesel::scip_desc_

    description of the node selector

    Definition at line 65 of file objnodesel.h.

    Referenced by ObjNodesel(), SCIPincludeObjNodesel(), and ~ObjNodesel().

    ◆ scip_stdpriority_

    const int scip::ObjNodesel::scip_stdpriority_

    priority of the node selector in standard mode

    Definition at line 68 of file objnodesel.h.

    Referenced by SCIPincludeObjNodesel().

    ◆ scip_memsavepriority_

    const int scip::ObjNodesel::scip_memsavepriority_

    priority of the node selector in memory saving mode

    Definition at line 71 of file objnodesel.h.

    Referenced by SCIPincludeObjNodesel().