Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Attributes | List of all members
core::scoring::func::CircularPowerFunc Class Reference

Generalization of CircularCircularPowerFunc – other exponents allowed. More...

#include <CircularPowerFunc.hh>

Inheritance diagram for core::scoring::func::CircularPowerFunc:
Inheritance graph
[legend]

Public Member Functions

 CircularPowerFunc (Real const x0_radians, Real const sd_radians, int const power, Real const weight)
 
FuncOP clone () const override
 This method must return a deep copy of this Func, meaning if this Func holds pointers to other Func objects, that it must clone those Func objects as well. More...
 
bool operator== (Func const &other) const override
 Equality operator. Looks for strict equality. Floating-point comparison is the rule rather than the exception. More...
 
bool same_type_as_me (Func const &other) const override
 Does the input Func, "other", have the same type as me? Necessary for the equality operator to function correctly. All derived Func classes must implement this function. More...
 
Real func (Real const x) const override
 Returns a value representing this function evaluated at a given point. More...
 
Real dfunc (Real const x) const override
 Returns a value representing the derivative of this function evaluated at a given point. More...
 
- Public Member Functions inherited from core::scoring::func::Func
 ~Func () override
 Automatically generated virtual destructor for class deriving directly from VirtualBase. More...
 
bool operator!= (Func const &other) const
 inequality operator – simply the negation of the (virtual) equality operator More...
 
virtual void read_data (std::istream &)
 initialize this Func from the given std::istream. More...
 
virtual Real estimate_dfunc (Real const r) const
 Estimates the derivative of this function at a given radius by calculating the slope of the secant line from func(r) and func(r+1e-05). More...
 
virtual Real estimate_dfunc (Real const r, Real const h) const
 Estimates the derivative of this function at a given radius by calculating the slope of the secant line from func(r) and func(r+h). More...
 
virtual void show (std::ostream &out) const
 Prints out space-delimited columns for r, func, dfunc and dfunc_est. The values for func, dfunc and dfunc_est are plotted as a function of r, which is varied from 2-20 in steps of 0.5. The value for dfunc_est is the estimated by the method estimate_dfunc( r ). More...
 
virtual void show_definition (std::ostream &out) const
 shows the definition of this function, usually the string type of function and the parameters passed in to the constructor. More...
 
virtual Size show_violations (std::ostream &out, Real r, Size verbose_level, Real threshold=1) const
 show some sort of stringified representation of the violations for this constraint. More...
 

Private Attributes

Real const x0_
 
Real const sd_
 
int const power_
 
Real const weight_
 

Detailed Description

Generalization of CircularCircularPowerFunc – other exponents allowed.

Operates in radians, like DihedralConstraint.

Constructor & Destructor Documentation

core::scoring::func::CircularPowerFunc::CircularPowerFunc ( Real const  x0_radians,
Real const  sd_radians,
int const  power,
Real const  weight 
)

References power_.

Member Function Documentation

FuncOP core::scoring::func::CircularPowerFunc::clone ( ) const
overridevirtual

This method must return a deep copy of this Func, meaning if this Func holds pointers to other Func objects, that it must clone those Func objects as well.

Implements core::scoring::func::Func.

Real core::scoring::func::CircularPowerFunc::dfunc ( Real const  const) const
overridevirtual

Returns a value representing the derivative of this function evaluated at a given point.

Implements core::scoring::func::Func.

References power_, sd_, weight_, and x0_.

Real core::scoring::func::CircularPowerFunc::func ( Real const  const) const
overridevirtual

Returns a value representing this function evaluated at a given point.

Implements core::scoring::func::Func.

References power_, sd_, weight_, and x0_.

bool core::scoring::func::CircularPowerFunc::operator== ( Func const &  other) const
overridevirtual

Equality operator. Looks for strict equality. Floating-point comparison is the rule rather than the exception.

Implements core::scoring::func::Func.

References power_, same_type_as_me(), core::scoring::func::Func::same_type_as_me(), sd_, weight_, and x0_.

bool core::scoring::func::CircularPowerFunc::same_type_as_me ( Func const &  other) const
overridevirtual

Does the input Func, "other", have the same type as me? Necessary for the equality operator to function correctly. All derived Func classes must implement this function.

Implements core::scoring::func::Func.

Referenced by operator==().

Member Data Documentation

int const core::scoring::func::CircularPowerFunc::power_
private
Real const core::scoring::func::CircularPowerFunc::sd_
private

Referenced by dfunc(), func(), and operator==().

Real const core::scoring::func::CircularPowerFunc::weight_
private

Referenced by dfunc(), func(), and operator==().

Real const core::scoring::func::CircularPowerFunc::x0_
private

Referenced by dfunc(), func(), and operator==().


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