Detailed Description

Simple distance restraint between two particles.

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

Public Member Functions
def	__init__
core::HarmonicUpperBound *	get_harmonic_upper_bound ()
core::DistanceRestraint *	get_restraint ()
VersionInfo	get_version_info () const
void	set_k (Float k)
	Set the spring constant for the HarmonicUpperBound.
void	set_mean (Float mean)
	Set the mean for the HarmonicUpperBound.
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 Particles &ps)

Related Functions
(Note that these are not member functions.)
SimpleDistance	create_simple_distance (const Particles &ps)

Member Function Documentation

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

Set the spring constant for the HarmonicUpperBound.

The default k is 1.

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

Set the mean for the HarmonicUpperBound.

The default mean is 0.

void IMP::restrainer::SimpleDistance::set_standard_deviation ( Float sd )

Set the standard deviation for the HarmonicUpperBound.

SimpleDistance create_simple_distance ( const Particles & ps )

Parameters:

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

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