IMP logo
Public Member Functions | Static Public Member Functions
IMP::core::HarmonicUpperBound Class Reference

Detailed Description

Upper bound harmonic function (non-zero when feature > mean)

See also:
Harmonic
HarmonicLowerBound
TruncatedHarmonicUpperBound

Examples: decay, custom filter, displaying ensembles, dock with crosslinks, six particles optimization, simulation, ms connectivity restraint, restrain diameter, optimize balls, connectivity restraint, incremental mc, restrain in sphere

+ Inheritance diagram for IMP::core::HarmonicUpperBound:

List of all members.

Public Member Functions

 HarmonicUpperBound (Float mean, Float k)
- Public Member Functions inherited from IMP::core::Harmonic
 Harmonic (Float mean, Float k)
Float get_k () const
Float get_mean () const
void set_k (Float k)
 Set the spring constant.
void set_mean (Float mean)
 Set the mean of this function.
- Public Member Functions inherited from IMP::UnaryFunction
virtual double evaluate (double feature) const
 Calculate score with respect to the given feature.
virtual DerivativePair evaluate_with_derivative (double feature) const
 Calculate score and derivative with respect to the given feature.
- 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 HarmonicUpperBoundget_from (IMP::base::Object *o)
- Static Public Member Functions inherited from IMP::core::Harmonic
static Float get_k_from_standard_deviation (Float sd, Float t=297.15)
 Return the k to use for a given Gaussian standard deviation.

Constructor & Destructor Documentation

IMP::core::HarmonicUpperBound::HarmonicUpperBound ( Float  mean,
Float  k 
)

Create with the given mean and the spring constant k


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

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