 |
Cosine function.
This evaluates the function |k| - k cos(nf + a) where k is a force constant, n the periodicity, a the phase, and f the input value. This is most commonly used for dihedral angle restraints, e.g. in the CHARMM force field.
Inheritance diagram for IMP::core::Cosine:Public Member Functions | |
| Cosine (Float force_constant, int periodicity, Float phase) | |
| Constructor. | |
| 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 Cosine * | get_from (IMP::base::Object *o) |
Constructor.
| [in] | force_constant | Force constant (score units) |
| [in] | periodicity | Periodicity (generally 1-6) |
| [in] | phase | Phase (radians) |
