A function that is harmonic over an interval. More...
#include <IMP/core/TruncatedHarmonic.h>
Inheritance diagram for IMP::core::TruncatedHarmonic< DIRECTION >: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... | |
| Public Member Functions inherited from IMP::kernel::UnaryFunction | |
| UnaryFunction (std::string name="UnaryFunction%1%") | |
| Public Member Functions inherited from IMP::base::Object | |
| virtual void | clear_caches () |
| 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. 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::base::Object | |
| Object (std::string name) | |
| Construct an object with the given name. More... | |
| Related Functions inherited from IMP::kernel::UnaryFunction | |
| typedef IMP::base::Vector < IMP::base::WeakPointer < UnaryFunction > > | UnaryFunctionsTemp |
Detailed Description
template<int DIRECTION>
class IMP::core::TruncatedHarmonic< DIRECTION >
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.
- Parameters
-
[in] DIRECTION Whether to be an upper bound, lower bound, or both directions. 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 39 of file TruncatedHarmonic.h.
Constructor & Destructor Documentation
| IMP::core::TruncatedHarmonic< DIRECTION >::TruncatedHarmonic | ( | Float | center, |
| Float | k, | ||
| Float | threshold, | ||
| Float | limit | ||
| ) |
- Parameters
-
[in] center The center point for the harmonic. [in] k The spring constant for the harmonic. [in] threshold How far the harmonic term extends from the center. [in] limit The value to which the function converges above the threshold.
- Note
- I don't like having 4 floats on the initializer list, but don't really see an alternative. There are a few sanity checks, so the order is a bit hard to get wrong.
Definition at line 51 of file TruncatedHarmonic.h.
| IMP::core::TruncatedHarmonic< DIRECTION >::TruncatedHarmonic | ( | Float | center, |
| Float | k, | ||
| Float | threshold | ||
| ) |
Set limit to a reasonable value.
Definition at line 57 of file TruncatedHarmonic.h.
Member Function Documentation
|
virtual |
- Parameters
-
[in] feature Value of feature being tested.
- Returns
- Score
Reimplemented from IMP::kernel::UnaryFunction.
Definition at line 68 of file TruncatedHarmonic.h.
|
virtual |
- Parameters
-
[in] feature Value of feature being tested.
- Returns
- a FloatPair containing the score and its partial derivative with respect to the given feaure.
Reimplemented from IMP::kernel::UnaryFunction.
Definition at line 61 of file TruncatedHarmonic.h.
The documentation for this class was generated from the following file: