Scippy

SCIP

Solving Constraint Integer Programs

bandit_epsgreedy.h
Go to the documentation of this file.
1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2 /* */
3 /* This file is part of the program and library */
4 /* SCIP --- Solving Constraint Integer Programs */
5 /* */
6 /* Copyright (C) 2002-2017 Konrad-Zuse-Zentrum */
7 /* fuer Informationstechnik Berlin */
8 /* */
9 /* SCIP is distributed under the terms of the ZIB Academic License. */
10 /* */
11 /* You should have received a copy of the ZIB Academic License */
12 /* along with SCIP; see the file COPYING. If not email to scip@zib.de. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file bandit_epsgreedy.h
17  * @ingroup INTERNALAPI
18  * @brief internal methods for epsilon greedy bandit selection
19  * @author Gregor Hendel
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_BANDIT_EPSGREEDY_H__
25 #define __SCIP_BANDIT_EPSGREEDY_H__
26 
27 
28 #include "scip/scip.h"
29 #include "scip/bandit.h"
30 
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34 
35 /** creates the epsilon greedy bandit algorithm includes it in SCIP */
36 extern
38  SCIP* scip /**< SCIP data structure */
39  );
40 
41 /** callback to free bandit specific data structures */
42 extern
43 SCIP_DECL_BANDITFREE(SCIPbanditFreeEpsgreedy);
44 
45 /** selection callback for bandit algorithm */
46 extern
47 SCIP_DECL_BANDITSELECT(SCIPbanditSelectEpsgreedy);
48 
49 /** update callback for bandit algorithm */
50 extern
51 SCIP_DECL_BANDITUPDATE(SCIPbanditUpdateEpsgreedy);
52 
53 /** reset callback for bandit algorithm */
54 extern
55 SCIP_DECL_BANDITRESET(SCIPbanditResetEpsgreedy);
56 
57 
58 /** internal method to create and reset epsilon greedy bandit algorithm */
59 extern
61  BMS_BLKMEM* blkmem, /**< block memory */
62  BMS_BUFMEM* bufmem, /**< buffer memory */
63  SCIP_BANDITVTABLE* vtable, /**< virtual function table with epsilon greedy callbacks */
64  SCIP_BANDIT** epsgreedy, /**< pointer to store the epsilon greedy bandit algorithm */
65  SCIP_Real* priorities, /**< nonnegative priorities for each action, or NULL if not needed */
66  SCIP_Real eps, /**< parameter to increase probability for exploration between all actions */
67  int nactions, /**< the number of possible actions */
68  unsigned int initseed /**< initial random seed */
69  );
70 
71 #ifdef __cplusplus
72 }
73 #endif
74 
75 #endif
SCIP_RETCODE SCIPbanditCreateEpsgreedy(BMS_BLKMEM *blkmem, BMS_BUFMEM *bufmem, SCIP_BANDITVTABLE *vtable, SCIP_BANDIT **epsgreedy, SCIP_Real *priorities, SCIP_Real eps, int nactions, unsigned int initseed)
internal methods for bandit algorithms
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:53
real eps
SCIP_DECL_BANDITSELECT(SCIPbanditSelectEpsgreedy)
SCIP_DECL_BANDITRESET(SCIPbanditResetEpsgreedy)
SCIP_DECL_BANDITUPDATE(SCIPbanditUpdateEpsgreedy)
SCIP_RETCODE SCIPincludeBanditvtableEpsgreedy(SCIP *scip)
SCIP_DECL_BANDITFREE(SCIPbanditFreeEpsgreedy)
#define SCIP_Real
Definition: def.h:149
struct BMS_BlkMem BMS_BLKMEM
Definition: memory.h:419
SCIP callable library.