dai::BBP::Properties Struct Reference

Parameters for BBP. More...

#include <dai/bbp.h>

List of all members.

Public Member Functions

 DAI_ENUM (UpdateType, SEQ_FIX, SEQ_MAX, SEQ_BP_REV, SEQ_BP_FWD, PAR)
 Enumeration of possible update schedules.
void set (const PropertySet &opts)
 Set members from PropertySet.
PropertySet get () const
 Get members into PropertySet.
std::string toString () const
 Convert to a string which can be parsed as a PropertySet.

Public Attributes

size_t verbose
 Verbosity (amount of output sent to stderr).
size_t maxiter
 Maximum number of iterations.
Real tol
 Tolerance for convergence test.
Real damping
 Damping constant (0 for none); damping = 1 - lambda where lambda is the damping constant used in [EaG09].
UpdateType updates
 Update schedule.


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

Verbosity (amount of output sent to stderr).

Maximum number of iterations.

Tolerance for convergence test.

Note:
Not used for updates = SEQ_BP_REV, SEQ_BP_FWD

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

Update schedule.


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

Generated on Thu Aug 5 19:04:03 2010 for libDAI by  doxygen 1.5.5