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

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

#include <ConstantFunc.hh>

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

Public Member Functions

 ConstantFunc (Real const return_val)
 
FuncOP clone () const
 returns a clone of this ConstantFunc More...
 
Real func (Real const ) const
 Returns the value of this ConstantFunc evaluated at distance x. More...
 
Real dfunc (Real const ) const
 Returns the value of the first derivative of this ConstantFunc at distance x. More...
 
virtual void show_definition (std::ostream &out) const
 show the definition of this ConstantFunc 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

Real return_val_
 

Friends

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

Detailed Description

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

Constructor & Destructor Documentation

core::scoring::constraints::ConstantFunc::ConstantFunc ( Real const  return_val)
inline

Referenced by clone().

Member Function Documentation

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

returns a clone of this ConstantFunc

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

References ConstantFunc().

Real core::scoring::constraints::ConstantFunc::dfunc ( Real const  ) const
virtual

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

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

Real core::scoring::constraints::ConstantFunc::func ( Real const  ) const
virtual

Returns the value of this ConstantFunc evaluated at distance x.

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

References return_val_.

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

initialize this Func from the given std::istream.

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

References return_val_.

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

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

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

References return_val_.

Friends And Related Function Documentation

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

Calls show( out ) on this ConstantFunc.

Member Data Documentation

Real core::scoring::constraints::ConstantFunc::return_val_
private

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


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