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

Class for representing arbitrarily defined functions. More...

#include <EtableFunc.hh>

Inheritance diagram for core::scoring::constraints::EtableFunc:
Inheritance graph
[legend]
Collaboration diagram for core::scoring::constraints::EtableFunc:
Collaboration graph
[legend]

Public Member Functions

 EtableFunc (Real const min_, Real const max_, Real const stepsize_)
 
FuncOP clone () const
 returns a clone of this EtableFunc More...
 
Real func (Real const x) const
 Returns the value of this EtableFunc evaluated at distance x. More...
 
Real dfunc (Real const x) const
 Returns the value of the first derivative of this EtableFunc at distance x. More...
 
virtual void show_definition (std::ostream &out) const
 show the definitio of this EtableFunc to the specified output stream. More...
 
void read_data (std::istream &in)
 initialize this Func from the given std::istream. More...
 
- Public Member Functions inherited from core::scoring::constraints::Func
virtual ~Func ()
 Automatically generated virtual destructor for class deriving directly from ReferenceCount. 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

utility::vector1< core::Realfunc_
 
core::Real min_
 
core::Real max_
 
core::Real stepsize_
 

Friends

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

Detailed Description

Class for representing arbitrarily defined functions.

Constructor & Destructor Documentation

core::scoring::constraints::EtableFunc::EtableFunc ( Real const  min_,
Real const  max_,
Real const  stepsize_ 
)
inline

Constuctor for EtableFunc. Arguments to the constructor are:

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

Referenced by clone().

Member Function Documentation

FuncOP core::scoring::constraints::EtableFunc::clone ( ) const
inlinevirtual

returns a clone of this EtableFunc

Implements core::scoring::constraints::Func.

References EtableFunc().

Real core::scoring::constraints::EtableFunc::dfunc ( Real const  x) const
virtual

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

Implements core::scoring::constraints::Func.

Real core::scoring::constraints::EtableFunc::func ( Real const  x) const
virtual

Returns the value of this EtableFunc evaluated at distance x.

Implements core::scoring::constraints::Func.

References func_, core::scoring::constraints::linear_interpolate(), min_, and stepsize_.

void core::scoring::constraints::EtableFunc::read_data ( std::istream &  )
virtual

initialize this Func from the given std::istream.

Reimplemented from core::scoring::constraints::Func.

References func_, max_, min_, and stepsize_.

void core::scoring::constraints::EtableFunc::show_definition ( std::ostream &  out) const
virtual

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

Reimplemented from core::scoring::constraints::Func.

References func_, max_, and min_.

Friends And Related Function Documentation

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

Calls show( out ) on this EtableFunc.

Member Data Documentation

utility::vector1< core::Real > core::scoring::constraints::EtableFunc::func_
private

Referenced by func(), read_data(), and show_definition().

core::Real core::scoring::constraints::EtableFunc::max_
private

Referenced by read_data(), and show_definition().

core::Real core::scoring::constraints::EtableFunc::min_
private

Referenced by func(), read_data(), and show_definition().

core::Real core::scoring::constraints::EtableFunc::stepsize_
private

Referenced by func(), and read_data().


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