dai::BBP::Properties Struct Reference

Parameters for BBP. More...

#include <dai/bbp.h>

Public Member Functions
	DAI_ENUM (UpdateType, SEQ_FIX, SEQ_MAX, SEQ_BP_REV, SEQ_BP_FWD, PAR)
	Enumeration of possible update schedules. 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...
size_t	maxiter
	Maximum number of iterations. More...
Real	tol
	Tolerance for convergence test. More...
Real	damping
	Damping constant (0 for none); damping = 1 - lambda where lambda is the damping constant used in [EaG09]. More...
UpdateType	updates
	Update schedule. More...

Detailed Description

Parameters for BBP.

Member Function Documentation

dai::BBP::Properties::DAI_ENUM	(	UpdateType	,
		SEQ_FIX	,
		SEQ_MAX	,
		SEQ_BP_REV	,
		SEQ_BP_FWD	,
		PAR
	)

Enumeration of possible update schedules.

The following update schedules are defined:

• SEQ_FIX fixed sequential updates
• SEQ_MAX maximum residual updates (inspired by [EMK06])
• SEQ_BP_REV schedule used by BP, but reversed
• SEQ_BP_FWD schedule used by BP
• PAR parallel updates

void dai::BBP::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::BBP::Properties::get

(

)

const

Get members into PropertySet.

string dai::BBP::Properties::toString

(

)

const

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

Member Data Documentation

size_t dai::BBP::Properties::verbose

Verbosity (amount of output sent to stderr)

size_t dai::BBP::Properties::maxiter

Maximum number of iterations.

Real dai::BBP::Properties::tol

Tolerance for convergence test.

Note

Not used for updates = SEQ_BP_REV, SEQ_BP_FWD

Real dai::BBP::Properties::damping

Damping constant (0 for none); damping = 1 - lambda where lambda is the damping constant used in [EaG09].

UpdateType dai::BBP::Properties::updates

Update schedule.

---

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

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