Rosetta 3.4
Public Member Functions
core::scoring::constraints::SquareWellFunc Class Reference

#include <SquareWellFunc.hh>

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

List of all members.

Public Member Functions

 SquareWellFunc (Real const x0_in, Real const well_depth_in)
FuncOP clone () const
Real func (Real const x) const
 Returns a value representing this function evaluated at a given point.
Real dfunc (Real const x) const
 Returns a value representing the derivative of this function evaluated at a given point.
void read_data (std::istream &in)
 initialize this Func from the given std::istream.
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.
Real x0 () const
Real well_depth () const
void x0 (Real x)
void well_depth (Real well_depth)
Size show_violations (std::ostream &out, Real x, Size verbose_level, core::Real threshold=1) const
 show some sort of stringified representation of the violations for this constraint.

Constructor & Destructor Documentation

core::scoring::constraints::SquareWellFunc::SquareWellFunc ( Real const  x0_in,
Real const  well_depth_in 
) [inline]

Referenced by clone().


Member Function Documentation

FuncOP core::scoring::constraints::SquareWellFunc::clone ( ) const [inline, virtual]
Real core::scoring::constraints::SquareWellFunc::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.

Real core::scoring::constraints::SquareWellFunc::func ( Real const  const) const [virtual]

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

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

void core::scoring::constraints::SquareWellFunc::read_data ( std::istream &  ) [virtual]

initialize this Func from the given std::istream.

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

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

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

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

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

Real core::scoring::constraints::SquareWellFunc::well_depth ( ) const [inline]
void core::scoring::constraints::SquareWellFunc::well_depth ( Real  well_depth) [inline]

References well_depth().

Referenced by well_depth().

Real core::scoring::constraints::SquareWellFunc::x0 ( ) const [inline]
void core::scoring::constraints::SquareWellFunc::x0 ( Real  x) [inline]

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines