dai::CBP::Properties Struct Reference

Parameters for CBP. More...

#include <dai/cbp.h>

Public Types
typedef BP::Properties::UpdateType	UpdateType
	Enumeration of possible update schedules. More...

Public Member Functions
	DAI_ENUM (RecurseType, REC_FIXED, REC_LOGZ, REC_BDIFF)
	Enumeration of possible methods for deciding when to stop recursing. More...
	DAI_ENUM (ChooseMethodType, CHOOSE_RANDOM, CHOOSE_MAXENT, CHOOSE_BBP, CHOOSE_BP_L1, CHOOSE_BP_CFN)
	Enumeration of possible heuristics for choosing clamping variable. More...
	DAI_ENUM (ClampType, CLAMP_VAR, CLAMP_FACTOR)
	Enumeration of possible clampings: variables or factors. More...
void	set (const PropertySet &opts)
	Set members from PropertySet. More...
PropertySet	get () const
	Get members into PropertySet. More...
std::string	toString () const
	Convert to a string which can be parsed as a PropertySet. More...

Public Attributes
size_t	verbose
	Verbosity (amount of output sent to stderr) More...
Real	tol
	Tolerance for BP convergence test. More...
UpdateType	updates
	Update style for BP. More...
size_t	maxiter
	Maximum number of iterations for BP. More...
Real	rec_tol
	Tolerance used for controlling recursion depth (recurse is REC_LOGZ or REC_BDIFF) More...
size_t	max_levels
	Maximum number of levels of recursion (recurse is REC_FIXED) More...
Real	min_max_adj
	If choose==CHOOSE_BBP and maximum adjoint is less than this value, don't recurse. More...
ChooseMethodType	choose
	Heuristic for choosing clamping variable. More...
RecurseType	recursion
	Method for deciding when to stop recursing. More...
ClampType	clamp
	Whether to clamp variables or factors. More...
PropertySet	bbp_props
	Properties to pass to BBP. More...
BBPCostFunction	bbp_cfn
	Cost function to use for BBP. More...
size_t	rand_seed
	Random seed. More...
std::string	clamp_outfile
	If non-empty, write clamping choices to this file. More...

Detailed Description

Parameters for CBP.

Member Typedef Documentation

typedef BP::Properties::UpdateType dai::CBP::Properties::UpdateType

Enumeration of possible update schedules.

Member Function Documentation

dai::CBP::Properties::DAI_ENUM	(	RecurseType	,
		REC_FIXED	,
		REC_LOGZ	,
		REC_BDIFF
	)

Enumeration of possible methods for deciding when to stop recursing.

dai::CBP::Properties::DAI_ENUM	(	ChooseMethodType	,
		CHOOSE_RANDOM	,
		CHOOSE_MAXENT	,
		CHOOSE_BBP	,
		CHOOSE_BP_L1	,
		CHOOSE_BP_CFN
	)

Enumeration of possible heuristics for choosing clamping variable.

dai::CBP::Properties::DAI_ENUM	(	ClampType	,
		CLAMP_VAR	,
		CLAMP_FACTOR
	)

Enumeration of possible clampings: variables or factors.

void dai::CBP::Properties::set

(

const PropertySet &

opts

)

Set members from PropertySet.

Exceptions

UNKNOWN_PROPERTY	if a Property key is not recognized
NOT_ALL_PROPERTIES_SPECIFIED	if an expected Property is missing

PropertySet dai::CBP::Properties::get

(

)

const

Get members into PropertySet.

string dai::CBP::Properties::toString

(

)

const

Convert to a string which can be parsed as a PropertySet.

Member Data Documentation

size_t dai::CBP::Properties::verbose

Verbosity (amount of output sent to stderr)

Real dai::CBP::Properties::tol

Tolerance for BP convergence test.

UpdateType dai::CBP::Properties::updates

Update style for BP.

size_t dai::CBP::Properties::maxiter

Maximum number of iterations for BP.

Real dai::CBP::Properties::rec_tol

Tolerance used for controlling recursion depth (recurse is REC_LOGZ or REC_BDIFF)

size_t dai::CBP::Properties::max_levels

Maximum number of levels of recursion (recurse is REC_FIXED)

Real dai::CBP::Properties::min_max_adj

If choose==CHOOSE_BBP and maximum adjoint is less than this value, don't recurse.

ChooseMethodType dai::CBP::Properties::choose

Heuristic for choosing clamping variable.

RecurseType dai::CBP::Properties::recursion

Method for deciding when to stop recursing.

ClampType dai::CBP::Properties::clamp

Whether to clamp variables or factors.

PropertySet dai::CBP::Properties::bbp_props

Properties to pass to BBP.

BBPCostFunction dai::CBP::Properties::bbp_cfn

Cost function to use for BBP.

size_t dai::CBP::Properties::rand_seed

Random seed.

std::string dai::CBP::Properties::clamp_outfile

If non-empty, write clamping choices to this file.

---

The documentation for this struct was generated from the following files:

• include/dai/cbp.h
• src/cbp.cpp