Scippy

    SCIP

    Solving Constraint Integer Programs

    Macros | Typedefs
    type_bandit.h File Reference
    Public API of SCIP » Core API » Type Definitions

    Detailed Description

    type definitions for bandit selection algorithms

    Author
    Gregor Hendel

    This file defines the interface for bandit selection algorithms implemented in C. see Bandit Algorithms for all publicly available bandit methods.

    Definition in file type_bandit.h.

    #include "scip/def.h"
    #include "scip/type_scip.h"
    #include "scip/type_result.h"
    #include "scip/type_timing.h"
    #include "blockmemshell/memory.h"

    Go to the source code of this file.

    Macros

    #define SCIP_DECL_BANDITFREE(x)
     
    #define SCIP_DECL_BANDITSELECT(x)
     
    #define SCIP_DECL_BANDITUPDATE(x)
     
    #define SCIP_DECL_BANDITRESET(x)
     

    Typedefs

    typedef struct SCIP_Bandit SCIP_BANDIT
     
    typedef struct SCIP_BanditVTable SCIP_BANDITVTABLE
     
    typedef struct SCIP_BanditData SCIP_BANDITDATA
     

    Macro Definition Documentation

    ◆ SCIP_DECL_BANDITFREE

    #define SCIP_DECL_BANDITFREE (   x)
    Value:
    SCIP_RETCODE x ( \
    BMS_BLKMEM* blkmem, \
    SCIP_BANDIT* bandit \
    )
    x
    SCIP_VAR ** x
    Definition: circlepacking.c:63
    BMS_BLKMEM
    struct BMS_BlkMem BMS_BLKMEM
    Definition: memory.h:437
    SCIP_Bandit
    Definition: struct_bandit.h:58
    SCIP_RETCODE
    enum SCIP_Retcode SCIP_RETCODE
    Definition: type_retcode.h:63

    callback to free bandit specific data structures

    Definition at line 63 of file type_bandit.h.

    ◆ SCIP_DECL_BANDITSELECT

    #define SCIP_DECL_BANDITSELECT (   x)
    Value:
    SCIP_RETCODE x ( \
    SCIP_BANDIT* bandit, \
    int* selection \
    )

    selection callback for bandit selector

    Definition at line 69 of file type_bandit.h.

    ◆ SCIP_DECL_BANDITUPDATE

    #define SCIP_DECL_BANDITUPDATE (   x)
    Value:
    SCIP_RETCODE x ( \
    SCIP_BANDIT* bandit, \
    int selection, \
    SCIP_Real score \
    )
    SCIP_Real
    #define SCIP_Real
    Definition: def.h:156

    update callback for bandit algorithms

    Definition at line 75 of file type_bandit.h.

    ◆ SCIP_DECL_BANDITRESET

    #define SCIP_DECL_BANDITRESET (   x)
    Value:
    SCIP_RETCODE x ( \
    BMS_BUFMEM* bufmem, \
    SCIP_BANDIT* bandit, \
    SCIP_Real* priorities \
    )
    BMS_BufMem
    Definition: memory.c:2545

    reset callback for bandit algorithms

    Definition at line 82 of file type_bandit.h.

    Typedef Documentation

    ◆ SCIP_BANDIT

    typedef struct SCIP_Bandit SCIP_BANDIT

    data structure for bandit algorithms

    Definition at line 50 of file type_bandit.h.

    ◆ SCIP_BANDITVTABLE

    typedef struct SCIP_BanditVTable SCIP_BANDITVTABLE

    virtual function table for bandit callbacks

    Definition at line 53 of file type_bandit.h.

    ◆ SCIP_BANDITDATA

    typedef struct SCIP_BanditData SCIP_BANDITDATA

    data structure for specific bandit algorithm implementation

    Definition at line 56 of file type_bandit.h.