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

a variant of the bound func that is periodic More...

#include <BoundConstraint.hh>

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

Public Types

typedef BoundFunc parent
 

Public Member Functions

 OffsetPeriodicBoundFunc (Real const lb, Real const ub, Real sd, std::string type, Real const periodicity_in, Real const offset_in)
 
FuncOP clone () const
 
void read_data (std::istream &)
 initialize this Func from the given std::istream. More...
 
Real func (Real const x) const
 Returns a value representing this function evaluated at a given point. More...
 
Real dfunc (Real const x) const
 Returns a value representing the derivative of this function evaluated at a given point. More...
 
void show_definition (std::ostream &out) const
 shows the definition of this function, usually the string type of function and the parameters passed in to the constructor. More...
 
virtual Size show_violations (std::ostream &out, Real x, Size verbose_level, Real threshold=1) const
 show some sort of stringified representation of the violations for this constraint. More...
 
- Public Member Functions inherited from core::scoring::constraints::BoundFunc
 BoundFunc (Real const lb, Real const ub, Real sd, std::string type)
 
 BoundFunc (Real const lb, Real const ub, Real sd, Real rswitch, std::string type)
 
Real lb () const
 
Real ub () const
 
Real sd () const
 
Real rswitch () const
 
std::string type () const
 
- 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...
 

Private Attributes

Real periodicity_
 
Real offset_
 

Detailed Description

a variant of the bound func that is periodic

Member Typedef Documentation

Constructor & Destructor Documentation

core::scoring::constraints::OffsetPeriodicBoundFunc::OffsetPeriodicBoundFunc ( Real const  lb,
Real const  ub,
Real  sd,
std::string  type,
Real const  periodicity_in,
Real const  offset_in 
)
inline

Referenced by clone().

Member Function Documentation

FuncOP core::scoring::constraints::OffsetPeriodicBoundFunc::clone ( ) const
inlinevirtual
Real core::scoring::constraints::OffsetPeriodicBoundFunc::dfunc ( Real const  const) const
inlinevirtual

Returns a value representing the derivative of this function evaluated at a given point.

Reimplemented from core::scoring::constraints::BoundFunc.

References core::scoring::constraints::BoundFunc::dfunc(), offset_, and periodicity_.

Real core::scoring::constraints::OffsetPeriodicBoundFunc::func ( Real const  const) const
inlinevirtual

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

Reimplemented from core::scoring::constraints::BoundFunc.

References core::scoring::constraints::BoundFunc::func(), offset_, and periodicity_.

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

initialize this Func from the given std::istream.

Reimplemented from core::scoring::constraints::BoundFunc.

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

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

Reimplemented from core::scoring::constraints::BoundFunc.

virtual Size core::scoring::constraints::OffsetPeriodicBoundFunc::show_violations ( std::ostream &  out,
Real  r,
Size  verbose_level,
Real  threshold = 1 
) const
inlinevirtual

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

Reimplemented from core::scoring::constraints::BoundFunc.

References periodicity_, and core::scoring::constraints::BoundFunc::show_violations().

Member Data Documentation

Real core::scoring::constraints::OffsetPeriodicBoundFunc::offset_
private

Referenced by dfunc(), and func().

Real core::scoring::constraints::OffsetPeriodicBoundFunc::periodicity_
private

Referenced by dfunc(), func(), and show_violations().


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