IMP logo
IMP Reference Guide  2.11.1
The Integrative Modeling Platform
IMP::score_functor::SurfaceHeightPairScore< DistanceScoreT > Class Template Reference

Create efficient surface height-based pair scores. More...

#include <IMP/score_functor/SurfaceDistancePairScore.h>

+ Inheritance diagram for IMP::score_functor::SurfaceHeightPairScore< DistanceScoreT >:

Detailed Description

template<class DistanceScoreT>
class IMP::score_functor::SurfaceHeightPairScore< DistanceScoreT >

Create efficient surface height-based pair scores.

This class allows one to create efficient height-based pair scores between a surface and a point in C++ by simply writing a functor (Score) that does the scoring.

Note
In the passed ParticleIndexPair, the first particle must be for the surface.
See Also
SurfaceDistancePairScore
DistancePairScore
Score

Definition at line 121 of file score_functor/SurfaceDistancePairScore.h.

Public Member Functions

 SurfaceHeightPairScore (const DistanceScore &t0, std::string name="FunctorSurfaceHeightPairScore %1%")
 
- Public Member Functions inherited from IMP::PairScore
 PairScore (std::string name="PairScore %1%")
 
Restraints create_current_decomposition (Model *m, const ParticleIndexPair &vt) const
 
virtual double evaluate_if_good_index (Model *m, const ParticleIndexPair &vt, DerivativeAccumulator *da, double max) const
 Compute the score and the derivative if needed, only if "good". More...
 
virtual double evaluate_if_good_indexes (Model *m, const ParticleIndexPairs &o, DerivativeAccumulator *da, double max, unsigned int lower_bound, unsigned int upper_bound) const
 
virtual double evaluate_index (Model *m, const ParticleIndexPair &vt, DerivativeAccumulator *da) const =0
 Compute the score and the derivative if needed. More...
 
virtual double evaluate_indexes (Model *m, const ParticleIndexPairs &o, DerivativeAccumulator *da, unsigned int lower_bound, unsigned int upper_bound) const
 Compute the score and the derivative if needed over a set. More...
 
- Public Member Functions inherited from IMP::ParticleInputs
ModelObjectsTemp get_inputs (Model *m, const ParticleIndexes &pis) const
 Get the ModelObjects read when the given list of particles is used. More...
 
- Public Member Functions inherited from IMP::Object
virtual void clear_caches ()
 
CheckLevel get_check_level () const
 
LogLevel get_log_level () const
 
virtual VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
 
void set_check_level (CheckLevel l)
 
void set_log_level (LogLevel l)
 Set the logging level used in this object. More...
 
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)
 
virtual std::string get_type_name () const
 

Additional Inherited Members

- Public Types inherited from IMP::PairScore
typedef ParticlePair Argument
 
typedef ParticleIndexPair IndexArgument
 
typedef PairModifier Modifier
 
typedef const ParticlePairPassArgument
 
typedef const ParticleIndexPairPassIndexArgument
 
- Protected Member Functions inherited from IMP::PairScore
virtual Restraints do_create_current_decomposition (Model *m, const ParticleIndexPair &vt) const
 Override this to return your own decomposition. More...
 
- Protected Member Functions inherited from IMP::ParticleInputs
virtual ModelObjectsTemp do_get_inputs (Model *m, const ParticleIndexes &pis) const =0
 Overload this method to specify the inputs. More...
 
- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

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