1    	/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2    	/*                                                                           */
3    	/*                  This file is part of the program and library             */
4    	/*         SCIP --- Solving Constraint Integer Programs                      */
5    	/*                                                                           */
6    	/*  Copyright 2002-2022 Zuse Institute Berlin                                */
7    	/*                                                                           */
8    	/*  Licensed under the Apache License, Version 2.0 (the "License");          */
9    	/*  you may not use this file except in compliance with the License.         */
10   	/*  You may obtain a copy of the License at                                  */
11   	/*                                                                           */
12   	/*      http://www.apache.org/licenses/LICENSE-2.0                           */
13   	/*                                                                           */
14   	/*  Unless required by applicable law or agreed to in writing, software      */
15   	/*  distributed under the License is distributed on an "AS IS" BASIS,        */
16   	/*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
17   	/*  See the License for the specific language governing permissions and      */
18   	/*  limitations under the License.                                           */
19   	/*                                                                           */
20   	/*  You should have received a copy of the Apache-2.0 license                */
21   	/*  along with SCIP; see the file LICENSE. If not visit scipopt.org.         */
22   	/*                                                                           */
23   	/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
24   	
25   	/**@file   bandit_exp3ix.h
26   	 * @ingroup INTERNALAPI
27   	 * @brief  internal methods for Exp.3-IX bandit algorithm
28   	 * @author Antonia Chmiela
29   	 */
30   	
31   	/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
32   	
33   	#ifndef __SCIP_BANDIT_EXP3IX_H__
34   	#define __SCIP_BANDIT_EXP3IX_H__
35   	
36   	
37   	#include "blockmemshell/memory.h"
38   	#include "scip/def.h"
39   	#include "scip/type_bandit.h"
40   	#include "scip/type_retcode.h"
41   	#include "scip/type_scip.h"
42   	
43   	#ifdef __cplusplus
44   	extern "C" {
45   	#endif
46   	
47   	/** include virtual function table for Exp.3-IX bandit algorithms */
48   	SCIP_RETCODE SCIPincludeBanditvtableExp3IX(
49   	   SCIP*                 scip                /**< SCIP data structure */
50   	   );
51   	
52   	/*
53   	 * callback methods for Exp.3-IX bandit algorithm to create a virtual function table
54   	 */
55   	
56   	/** callback to free bandit specific data structures */
57   	SCIP_DECL_BANDITFREE(SCIPbanditFreeExp3IX);
58   	
59   	/** selection callback for bandit selector */
60   	SCIP_DECL_BANDITSELECT(SCIPbanditSelectExp3IX);
61   	
62   	/** update callback for bandit algorithm */
63   	SCIP_DECL_BANDITUPDATE(SCIPbanditUpdateExp3IX);
64   	
65   	/** reset callback for bandit algorithm */
66   	SCIP_DECL_BANDITRESET(SCIPbanditResetExp3IX);
67   	
68   	/** direct bandit creation method for the core where no SCIP pointer is available */
69   	SCIP_RETCODE SCIPbanditCreateExp3IX(
70   	   BMS_BLKMEM*           blkmem,             /**< block memory data structure */
71   	   BMS_BUFMEM*           bufmem,             /**< buffer memory */
72   	   SCIP_BANDITVTABLE*    vtable,             /**< virtual function table for callback functions of Exp.3-IX */
73   	   SCIP_BANDIT**         exp3ix,             /**< pointer to store bandit algorithm */
74   	   SCIP_Real*            priorities,         /**< nonnegative priorities for each action, or NULL if not needed */
75   	   int                   nactions,           /**< the positive number of actions for this bandit algorithm */
76   	   unsigned int          initseed            /**< initial random seed */
77   	   );
78   	
79   	#ifdef __cplusplus
80   	}
81   	#endif
82   	
83   	#endif
84