IMP logo

IMP::core::DistanceRestraint Class Reference


Detailed Description

Distance restraint between two particles.

Note:
If the particles are closer than a certain distance, then the contributions to the derivatives are set to 0.
See also:
PairRestraint

DistancePairScore

SphereDistancePairScore

Inheritance diagram for IMP::core::DistanceRestraint:

Inheritance graph
[legend]

Public Member Functions

 DistanceRestraint (UnaryFunction *score_func, XYZ a, XYZ b)
 DistanceRestraint (UnaryFunction *score_func, Particle *a, Particle *b)
 Create the distance restraint.
ContainersTemp get_input_containers () const
ParticlesTemp get_input_particles () const
ParticlesList get_interacting_particles () const
virtual std::string get_type_name () const
virtual ::IMP::VersionInfo get_version_info () const
virtual double unprotected_evaluate (DerivativeAccumulator *accum) const

Friends

template<class T >
void IMP::internal::unref (T *)

Constructor & Destructor Documentation

IMP::core::DistanceRestraint::DistanceRestraint ( UnaryFunction score_func,
Particle a,
Particle b 
)

Create the distance restraint.

Parameters:
[in] score_func Scoring function for the restraint.
[in] a Pointer to first particle in distance restraint.
[in] b Pointer to second particle in distance restraint.


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

Generated on Mon Mar 8 23:08:56 2010 for IMP by doxygen 1.5.8