IMP Reference Guide
2.14.0
The Integrative Modeling Platform
|
A function that is harmonic over an interval. More...
#include <IMP/core/TruncatedHarmonic.h>
A function that is harmonic over an interval.
This function is harmonic between center and threshold and then asymptotically converges to the limit value.
The function form above the threshold is currently limit-b/(x-o) where x is the offset from the center and b,o are constants chosen to make the function smooth and continuous. This form may change without notice unless someone tells us it is important that it does not.
[in] | DIRECTION | Whether the harmonic is of an upper bound, lower bound, or both directions type. It should be one of the BoundDirection enum values. If it is LOWER, than the function is 0 for all values above the passed center. |
Definition at line 43 of file TruncatedHarmonic.h.
Public Member Functions | |
TruncatedHarmonic (Float center, Float k, Float threshold, Float limit) | |
TruncatedHarmonic (Float center, Float k, Float threshold) | |
virtual double | evaluate (double feature) const |
Calculate score with respect to the given feature. More... | |
virtual DerivativePair | evaluate_with_derivative (double feature) const |
Calculate score and derivative with respect to the given feature. More... | |
virtual std::string | get_type_name () const |
virtual ::IMP::VersionInfo | get_version_info () const |
Get information about the module and version of the object. More... | |
Public Member Functions inherited from IMP::UnaryFunction | |
UnaryFunction (std::string name="UnaryFunction%1%") | |
Public Member Functions inherited from IMP::Object | |
virtual void | clear_caches () |
CheckLevel | get_check_level () const |
LogLevel | get_log_level () const |
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) |
Additional Inherited Members | |
Protected Member Functions inherited from IMP::Object | |
Object (std::string name) | |
Construct an object with the given name. More... | |
virtual void | do_destroy () |
IMP::core::TruncatedHarmonic< DIRECTION >::TruncatedHarmonic | ( | Float | center, |
Float | k, | ||
Float | threshold, | ||
Float | limit | ||
) |
[in] | center | The center point for the truncated harmonic. |
[in] | k | The spring constant for the truncated harmonic. |
[in] | threshold | How far the harmonic term extends from the center. |
[in] | limit | The value to which the function converges above the threshold. |
Definition at line 55 of file TruncatedHarmonic.h.
IMP::core::TruncatedHarmonic< DIRECTION >::TruncatedHarmonic | ( | Float | center, |
Float | k, | ||
Float | threshold | ||
) |
Same as other constructor, but automatically set limit to a reasonable default value.
Definition at line 58 of file TruncatedHarmonic.h.
|
virtual |
Calculate score with respect to the given feature.
[in] | feature | Value of feature being tested. |
Reimplemented from IMP::UnaryFunction.
Definition at line 68 of file TruncatedHarmonic.h.
|
virtual |
Calculate score and derivative with respect to the given feature.
[in] | feature | Value of feature being tested. |
Reimplemented from IMP::UnaryFunction.
Definition at line 60 of file TruncatedHarmonic.h.
|
virtual |
Get information about the module and version of the object.
Reimplemented from IMP::Object.
Definition at line 74 of file TruncatedHarmonic.h.