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

Derived class of class Func representing a Soeding distribution with a user-specified mean and standard deviation. More...

#include <SoedingFunc.hh>

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

Public Member Functions

 SoedingFunc ()
 
FuncOP clone () const override
 returns a clone of this SoedingFunc 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 compute_func (Real const x) const
 
Real func (Real const x) const override
 Returns the value of this SoedingFunc evaluated at distance x. More...
 
Real dfunc (Real const x) const override
 Returns the value of the first derivative of this SoedingFunc at distance x. More...
 
void show_definition (std::ostream &out) const override
 show the definition of this SoedingFunc to the specified output stream. More...
 
void read_data (std::istream &in) override
 Initializes this SoedingFunc from the given istream. 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...
 
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 w1_
 
Real mean1_
 
Real sdev1_
 
Real w2_
 
Real mean2_
 
Real sdev2_
 

Friends

std::ostream & operator<< (std::ostream &out, const SoedingFunc &f)
 Calls show( out ) on this SoedingFunc. More...
 

Detailed Description

Derived class of class Func representing a Soeding distribution with a user-specified mean and standard deviation.

Constructor & Destructor Documentation

core::scoring::func::SoedingFunc::SoedingFunc ( )
inline

Member Function Documentation

FuncOP core::scoring::func::SoedingFunc::clone ( ) const
inlineoverridevirtual

returns a clone of this SoedingFunc

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

Real core::scoring::func::SoedingFunc::compute_func ( Real const  x) const
Real core::scoring::func::SoedingFunc::dfunc ( Real const  x) const
overridevirtual

Returns the value of the first derivative of this SoedingFunc at distance x.

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

Real core::scoring::func::SoedingFunc::func ( Real const  x) const
overridevirtual
bool core::scoring::func::SoedingFunc::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 core::scoring::func::Func::same_type_as_me().

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

Initializes this SoedingFunc from the given istream.

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

bool core::scoring::func::SoedingFunc::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.

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

show the definition of this SoedingFunc to the specified output stream.

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

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  out,
const SoedingFunc f 
)
friend

Calls show( out ) on this SoedingFunc.

Member Data Documentation

Real core::scoring::func::SoedingFunc::mean1_
private
Real core::scoring::func::SoedingFunc::mean2_
private
Real core::scoring::func::SoedingFunc::sdev1_
private
Real core::scoring::func::SoedingFunc::sdev2_
private
Real core::scoring::func::SoedingFunc::w1_
private
Real core::scoring::func::SoedingFunc::w2_
private

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