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

#include <FadeFunc.hh>

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

Public Member Functions

 FadeFunc (Real const cutoff_lower, Real const cutoff_upper, Real const fade_zone, Real const well_depth, Real const well_offset)
 
 FadeFunc (Real const cutoff_lower, Real const cutoff_upper, Real const fade_zone, Real const well_depth)
 
 FadeFunc (Real const cutoff_lower, Real const cutoff_upper, Real const fade_zone)
 
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...
 
void read_data (std::istream &in) override
 initialize this Func from the given std::istream. More...
 
void show_definition (std::ostream &out) const override
 shows the definition of this function, usually the string type of function and the parameters passed in to the constructor. More...
 
Real cutoff_upper () const
 
Real cutoff_lower () const
 
Real fade_zone () const
 
void cutoff_upper (Real x)
 
void cutoff_lower (Real x)
 
void fade_zone (Real x)
 
Size show_violations (std::ostream &out, Real x, Size verbose_level, core::Real threshold=1) const override
 show some sort of stringified representation of the violations for this constraint. 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 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...
 

Private Attributes

Real cutoff_lower_
 
Real cutoff_upper_
 
Real fade_zone_
 
Real well_depth_
 
Real well_offset_
 

Constructor & Destructor Documentation

core::scoring::func::FadeFunc::FadeFunc ( Real const  cutoff_lower,
Real const  cutoff_upper,
Real const  fade_zone,
Real const  well_depth,
Real const  well_offset 
)
inline
core::scoring::func::FadeFunc::FadeFunc ( Real const  cutoff_lower,
Real const  cutoff_upper,
Real const  fade_zone,
Real const  well_depth 
)
inline
core::scoring::func::FadeFunc::FadeFunc ( Real const  cutoff_lower,
Real const  cutoff_upper,
Real const  fade_zone 
)
inline

Member Function Documentation

FuncOP core::scoring::func::FadeFunc::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.

References cutoff_lower_, cutoff_upper_, fade_zone_, well_depth_, and well_offset_.

Real core::scoring::func::FadeFunc::cutoff_lower ( ) const
inline

References cutoff_lower_.

void core::scoring::func::FadeFunc::cutoff_lower ( Real  x)
inline

References cutoff_lower_.

Real core::scoring::func::FadeFunc::cutoff_upper ( ) const
inline

References cutoff_upper_.

void core::scoring::func::FadeFunc::cutoff_upper ( Real  x)
inline

References cutoff_upper_.

Real core::scoring::func::FadeFunc::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 protocols::match::upstream::b, cutoff_lower_, cutoff_upper_, fade_zone_, and well_depth_.

Real core::scoring::func::FadeFunc::fade_zone ( ) const
inline

References fade_zone_.

void core::scoring::func::FadeFunc::fade_zone ( Real  x)
inline

References fade_zone_.

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

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

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

References protocols::match::upstream::b, cutoff_lower_, cutoff_upper_, fade_zone_, well_depth_, and well_offset_.

bool core::scoring::func::FadeFunc::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 cutoff_lower_, cutoff_upper_, fade_zone_, core::scoring::func::Func::same_type_as_me(), same_type_as_me(), well_depth_, and well_offset_.

void core::scoring::func::FadeFunc::read_data ( std::istream &  )
overridevirtual

initialize this Func from the given std::istream.

Reimplemented from core::scoring::func::Func.

References core::pack::dunbrack::c, cutoff_lower_, cutoff_upper_, fade_zone_, well_depth_, and well_offset_.

bool core::scoring::func::FadeFunc::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==().

void core::scoring::func::FadeFunc::show_definition ( std::ostream &  out) const
overridevirtual

shows the definition of this function, usually the string type of function and the parameters passed in to the constructor.

Reimplemented from core::scoring::func::Func.

References cutoff_lower_, cutoff_upper_, fade_zone_, well_depth_, and well_offset_.

Size core::scoring::func::FadeFunc::show_violations ( std::ostream &  out,
Real  r,
Size  verbose_level,
core::Real  threshold = 1 
) const
overridevirtual

show some sort of stringified representation of the violations for this constraint.

Reimplemented from core::scoring::func::Func.

References cutoff_upper_, and core::scoring::func::Func::show_violations().

Member Data Documentation

Real core::scoring::func::FadeFunc::cutoff_lower_
private
Real core::scoring::func::FadeFunc::cutoff_upper_
private
Real core::scoring::func::FadeFunc::fade_zone_
private
Real core::scoring::func::FadeFunc::well_depth_
private
Real core::scoring::func::FadeFunc::well_offset_
private

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