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

#include <BoundConstraint.hh>

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

Public Member Functions

 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)
 
virtual FuncOP clone () const
 
virtual void read_data (std::istream &)
 initialize this Func from the given std::istream. More...
 
virtual Real func (Real const x) const
 Returns a value representing this function evaluated at a given point. More...
 
virtual Real dfunc (Real const x) const
 Returns a value representing the derivative of this function evaluated at a given point. More...
 
virtual 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...
 
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 lb_
 
Real ub_
 
Real sd_
 
Real rswitch_
 
std::string type_
 

Constructor & Destructor Documentation

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

Referenced by clone().

core::scoring::constraints::BoundFunc::BoundFunc ( Real const  lb,
Real const  ub,
Real  sd,
Real  rswitch,
std::string  type 
)
inline

Member Function Documentation

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

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

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

Reimplemented in core::scoring::constraints::OffsetPeriodicBoundFunc, and core::scoring::constraints::PeriodicBoundFunc.

References lb_, rswitch_, sd_, and ub_.

Referenced by core::scoring::constraints::PeriodicBoundFunc::dfunc(), and core::scoring::constraints::OffsetPeriodicBoundFunc::dfunc().

Real core::scoring::constraints::BoundFunc::func ( Real const  const) const
virtual
Real core::scoring::constraints::BoundFunc::lb ( ) const
inline

References lb_.

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

initialize this Func from the given std::istream.

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

Reimplemented in core::scoring::constraints::OffsetPeriodicBoundFunc, and core::scoring::constraints::PeriodicBoundFunc.

References lb_, rswitch_, sd_, type_, and ub_.

Real core::scoring::constraints::BoundFunc::rswitch ( ) const
inline

References rswitch_.

Real core::scoring::constraints::BoundFunc::sd ( ) const
inline

References sd_.

void core::scoring::constraints::BoundFunc::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::Func.

Reimplemented in core::scoring::constraints::OffsetPeriodicBoundFunc, and core::scoring::constraints::PeriodicBoundFunc.

References lb_, rswitch_, sd_, type_, and ub_.

Size core::scoring::constraints::BoundFunc::show_violations ( std::ostream &  out,
Real  r,
Size  verbose_level,
Real  threshold = 1 
) const
virtual
std::string core::scoring::constraints::BoundFunc::type ( ) const
inline

References type_.

Real core::scoring::constraints::BoundFunc::ub ( ) const
inline

References ub_.

Member Data Documentation

Real core::scoring::constraints::BoundFunc::lb_
private
Real core::scoring::constraints::BoundFunc::rswitch_
private
Real core::scoring::constraints::BoundFunc::sd_
private
std::string core::scoring::constraints::BoundFunc::type_
private
Real core::scoring::constraints::BoundFunc::ub_
private

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