PublicBanditAlgorithms

Detailed Description

Functions
SCIP_RETCODE	SCIPincludeBanditvtable (SCIP *scip, SCIP_BANDITVTABLE **banditvtable, const char *name, SCIP_DECL_BANDITFREE((*banditfree)), SCIP_DECL_BANDITSELECT((*banditselect)), SCIP_DECL_BANDITUPDATE((*banditupdate)), SCIP_DECL_BANDITRESET((*banditreset)))
SCIP_BANDITVTABLE *	SCIPfindBanditvtable (SCIP *scip, const char *name)
SCIP_RETCODE	SCIPfreeBandit (SCIP *scip, SCIP_BANDIT **bandit)
SCIP_RETCODE	SCIPresetBandit (SCIP *scip, SCIP_BANDIT *bandit, SCIP_Real *priorities, unsigned int seed)

Function Documentation

SCIPincludeBanditvtable()

SCIP_RETCODE SCIPincludeBanditvtable	(	SCIP *	scip,
		SCIP_BANDITVTABLE **	banditvtable,
		const char *	name,
		SCIP_DECL_BANDITFREE((*banditfree))	,
		SCIP_DECL_BANDITSELECT((*banditselect))	,
		SCIP_DECL_BANDITUPDATE((*banditupdate))	,
		SCIP_DECL_BANDITRESET((*banditreset))
	)

includes a bandit algorithm virtual function table

Parameters

scip	SCIP data structure
banditvtable	bandit algorithm virtual function table
name	a name for the algorithm represented by this vtable

Definition at line 32 of file scip_bandit.c.

References SCIP_CALL, SCIP_INVALIDDATA, SCIP_OKAY, SCIPbanditvtableCreate(), SCIPerrorMessage, SCIPfindBanditvtable(), SCIPsetIncludeBanditvtable(), and Scip::set.

Referenced by SCIPincludeBanditvtableEpsgreedy(), SCIPincludeBanditvtableExp3(), and SCIPincludeBanditvtableUcb().

SCIPfindBanditvtable()

SCIP_BANDITVTABLE* SCIPfindBanditvtable	(	SCIP *	scip,
		const char *	name
	)

returns the bandit virtual function table of the given name, or NULL if not existing

Parameters

scip	SCIP data structure
name	name of bandit algorithm virtual function table

Definition at line 64 of file scip_bandit.c.

References SCIPsetFindBanditvtable(), and Scip::set.

Referenced by SCIPcreateBanditEpsgreedy(), SCIPcreateBanditExp3(), SCIPcreateBanditUcb(), and SCIPincludeBanditvtable().

SCIPfreeBandit()

SCIP_RETCODE SCIPfreeBandit	(	SCIP *	scip,
		SCIP_BANDIT **	bandit
	)

calls destructor and frees memory of bandit algorithm

Parameters

scip	SCIP data structure
bandit	pointer to bandit algorithm data structure

Definition at line 91 of file scip_bandit.c.

References SCIP_CALL, SCIP_OKAY, SCIPbanditFree(), and SCIPblkmem().

Referenced by SCIP_DECL_HEURFREE(), and SCIP_DECL_HEURINITSOL().

SCIPresetBandit()

SCIP_RETCODE SCIPresetBandit	(	SCIP *	scip,
		SCIP_BANDIT *	bandit,
		SCIP_Real *	priorities,
		unsigned int	seed
	)

reset the bandit algorithm

Parameters

scip	SCIP data structure
bandit	pointer to bandit algorithm data structure
priorities	priorities for every action, or NULL if not needed
seed	initial random seed for bandit selection

Definition at line 75 of file scip_bandit.c.

References SCIP_CALL, SCIP_OKAY, SCIPbanditReset(), SCIPbuffer(), and SCIPinitializeRandomSeed().

Referenced by SCIP_DECL_HEURINITSOL().