IMP logo
Public Member Functions | Static Public Member Functions
IMP::isd::vonMisesKappaConjugateRestraint Class Reference

Detailed Description

Conjugate prior for the concentration parameter of a von Mises distribution.

\[ p(\kappa|c,R_0) = \frac{\exp(\kappa R_0)}{I_0(\kappa)^c} \]

$0 < R_0 \le c$ where $kappa$ is the concentration parameter. Default values: $R_0=1$ and $c=10$

+ Inheritance diagram for IMP::isd::vonMisesKappaConjugateRestraint:

List of all members.

Public Member Functions

 vonMisesKappaConjugateRestraint (Particle *kappa, double c=10.0, double R0=0.0)
 Create the restraint.
virtual double get_probability () const
- Public Member Functions inherited from IMP::isd::ISDRestraint
def __init__
 ISDRestraint (std::string name)
- Public Member Functions inherited from IMP::Restraint
 Restraint (Model *m, std::string name)
Restraintcreate_current_decomposition () const
 Decompose this restraint into constituent terms for the current conf.
Restraintcreate_decomposition () const
 Decompose this restraint into constituent terms.
double evaluate (bool calc_derivs) const
 Return the score for this restraint for the current state of the model.
double evaluate_if_below (bool calc_derivatives, double max) const
 See Model::evaluate_with_maximum()
double evaluate_if_good (bool calc_derivatives) const
 See Model::evaluate_if_good()
double get_last_score () const
bool get_was_good () const
virtual double unprotected_evaluate (DerivativeAccumulator *) const =0
virtual double unprotected_evaluate_if_good (DerivativeAccumulator *da, double max) const
virtual double unprotected_evaluate_if_below (DerivativeAccumulator *da, double max) const
virtual ContainersTemp get_input_containers () const =0
virtual ParticlesTemp get_input_particles () const =0
void set_weight (Float weight)
Float get_weight () const
double get_maximum_score () const
void set_maximum_score (double s)
- Public Member Functions inherited from IMP::ModelObject
 ModelObject (Model *m, std::string name)
ModelObjectsTemp get_inputs () const
Modelget_model () const
ModelObjectsTemp get_outputs () const
- Public Member Functions inherited from IMP::base::Object
std::size_t __hash__ () const
virtual std::string get_type_name () const =0
 Return a string identifying the type of the object.
virtual IMP::base::VersionInfo get_version_info () const =0
 Get information about the module and version of the object.
void set_check_level (CheckLevel l)
void set_log_level (LogLevel l)
 Set the logging level used in this object.
void set_was_used (bool tf) const
void show (std::ostream &out=std::cout) const
const std::string & get_name () const
void set_name (std::string name)

Static Public Member Functions

static
vonMisesKappaConjugateRestraint
get_from (IMP::base::Object *o)

Constructor & Destructor Documentation

IMP::isd::vonMisesKappaConjugateRestraint::vonMisesKappaConjugateRestraint ( Particle kappa,
double  c = 10.0,
double  R0 = 0.0 
)

Create the restraint.


Member Function Documentation

static vonMisesKappaConjugateRestraint* IMP::isd::vonMisesKappaConjugateRestraint::get_from ( IMP::base::Object o)
static

This macro declares the basic needed methods: evaluate and show


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

Generated on Tue May 22 2012 23:33:36 for IMP by doxygen 1.8.1