Simple distance restraint between two particles. More...

Public Member Functions
core::HarmonicUpperBound *	get_harmonic_upper_bound ()

core::DistanceRestraint *	get_restraint ()

base::VersionInfo	get_version_info () const

void	set_k (Float k)
	Set the spring constant for the HarmonicUpperBound. More...

void	set_mean (Float mean)
	Set the mean for the HarmonicUpperBound. More...

void	set_standard_deviation (Float sd)
	Set the standard deviation for the HarmonicUpperBound.

void	show (std::ostream &out=std::cout) const

Friends
SimpleDistance	create_simple_distance (const kernel::Particles &ps)

Detailed Description

Note: SimpleDistance stores pointers to DistanceRestraint, and HarmonicUpperBound.; It provides convenient methods to change mean, k, and standard deviation.

Definition at line 233 of file simplify_restraint.h.

Member Function Documentation

void IMP::restrainer::SimpleDistance::set_k ( Float k )

The default k is 1.

Definition at line 266 of file simplify_restraint.h.

void IMP::restrainer::SimpleDistance::set_mean ( Float mean )

The default mean is 0.

Definition at line 251 of file simplify_restraint.h.

SimpleDistance create_simple_distance ( const kernel::Particles & ps )

friend

Creates DistanceRestraint using HarmonicUpperBound scoring function as default.

Parameters

[in] ps Pointer to two particles in distance restraint. See SimpleDistance

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