hops
Public Types | Public Member Functions | List of all members
hops::BallWalkProposal< MatrixType, VectorType > Class Template Reference

#include <BallWalkProposal.hpp>

Collaboration diagram for hops::BallWalkProposal< MatrixType, VectorType >:
Collaboration graph

Public Types

using StateType = VectorType
 

Public Member Functions

 BallWalkProposal (MatrixType A, VectorType b, StateType currentState, typename MatrixType::Scalar stepSize=1)
 Constructs Ballwalk m_proposal mechanism on polytope defined as Ax<b. More...
 
void propose (RandomNumberGenerator &randomNumberGenerator)
 
void acceptProposal ()
 
StateType getState () const
 
StateType getProposal () const
 
void setState (StateType newState)
 
void setStepSize (typename MatrixType::Scalar stepSize)
 
MatrixType::Scalar getStepSize () const
 
MatrixType::Scalar computeLogAcceptanceProbability ()
 
std::string getName ()
 

Member Typedef Documentation

◆ StateType

template<typename MatrixType , typename VectorType >
using hops::BallWalkProposal< MatrixType, VectorType >::StateType = VectorType

Constructor & Destructor Documentation

◆ BallWalkProposal()

template<typename MatrixType , typename VectorType >
hops::BallWalkProposal< MatrixType, VectorType >::BallWalkProposal ( MatrixType  A,
VectorType  b,
StateType  currentState,
typename MatrixType::Scalar  stepSize = 1 
)

Constructs Ballwalk m_proposal mechanism on polytope defined as Ax<b.

Parameters
A
b
currentState
stepSizeThe radius of the ball from which the m_proposal move is drawn

Member Function Documentation

◆ acceptProposal()

template<typename MatrixType , typename VectorType >
void hops::BallWalkProposal< MatrixType, VectorType >::acceptProposal

◆ computeLogAcceptanceProbability()

template<typename MatrixType , typename VectorType >
MatrixType::Scalar hops::BallWalkProposal< MatrixType, VectorType >::computeLogAcceptanceProbability ( )
inline

◆ getName()

template<typename MatrixType , typename VectorType >
std::string hops::BallWalkProposal< MatrixType, VectorType >::getName

◆ getProposal()

template<typename MatrixType , typename VectorType >
BallWalkProposal< MatrixType, VectorType >::StateType hops::BallWalkProposal< MatrixType, VectorType >::getProposal

◆ getState()

template<typename MatrixType , typename VectorType >
BallWalkProposal< MatrixType, VectorType >::StateType hops::BallWalkProposal< MatrixType, VectorType >::getState

◆ getStepSize()

template<typename MatrixType , typename VectorType >
MatrixType::Scalar hops::BallWalkProposal< MatrixType, VectorType >::getStepSize

◆ propose()

template<typename MatrixType , typename VectorType >
void hops::BallWalkProposal< MatrixType, VectorType >::propose ( RandomNumberGenerator randomNumberGenerator)

◆ setState()

template<typename MatrixType , typename VectorType >
void hops::BallWalkProposal< MatrixType, VectorType >::setState ( StateType  newState)

◆ setStepSize()

template<typename MatrixType , typename VectorType >
void hops::BallWalkProposal< MatrixType, VectorType >::setStepSize ( typename MatrixType::Scalar  stepSize)

The documentation for this class was generated from the following file: