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::GaussianFunc Class Reference

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

#include <GaussianFunc.hh>

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

Public Member Functions

 GaussianFunc (Real const mean, Real const sd)
 
FuncOP clone () const override
 returns a clone of this GaussianFunc 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 the value of this GaussianFunc evaluated at distance x. More...
 
Real dfunc (Real const x) const override
 Returns the value of the first derivative of this GaussianFunc at distance x. More...
 
void show_definition (std::ostream &out) const override
 show the definitio of this GaussianFunc to the specified output stream. More...
 
void read_data (std::istream &in) override
 The parameters are: 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 mean_
 
Real sd_
 
bool use_log_score_
 
Real weight_
 A multiplier for the Gaussian function. More...
 

Friends

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

Detailed Description

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

Constructor & Destructor Documentation

core::scoring::func::GaussianFunc::GaussianFunc ( Real const  mean,
Real const  sd 
)
inline

Constuctor for GaussianFunc. Arguments to the constructor are:

  • mean: parameter representing the mean of this function.
  • sd: parameter representing the standard deviation of this function.

Member Function Documentation

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

returns a clone of this GaussianFunc

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

Real core::scoring::func::GaussianFunc::dfunc ( Real const  x) const
overridevirtual

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

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

References core::scoring::constraints::gaussian_deriv(), and core::scoring::constraints::logdgaussian_deriv().

Real core::scoring::func::GaussianFunc::func ( Real const  x) const
overridevirtual
bool core::scoring::func::GaussianFunc::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::GaussianFunc::read_data ( std::istream &  in)
overridevirtual

The parameters are:

Initializes this GaussianFunc from the given istream. An example of the type of string from which the istream should be constructed is: "GAUSSIANFUNC 19.396 7.643". The interpretation is to create initialize this GaussianFunc object with the following parameters:

  • mean 19.396
  • sd 7.643

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

bool core::scoring::func::GaussianFunc::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::GaussianFunc::show_definition ( std::ostream &  out) const
overridevirtual

show the definitio of this GaussianFunc to the specified output stream.

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

Friends And Related Function Documentation

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

Calls show( out ) on this GaussianFunc.

Member Data Documentation

Real core::scoring::func::GaussianFunc::mean_
private
Real core::scoring::func::GaussianFunc::sd_
private
bool core::scoring::func::GaussianFunc::use_log_score_
private
Real core::scoring::func::GaussianFunc::weight_
private

A multiplier for the Gaussian function.

Author
Vikram K. Mulligan (vmull.nosp@m.ig@u.nosp@m.w.edu).

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