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

#include <HarmonicFunc.hh>

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

List of all members.

Public Member Functions

 HarmonicFunc (Real const x0_in, Real const sd_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 sd () const
void x0 (Real x)
void sd (Real sd)
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::HarmonicFunc::HarmonicFunc ( Real const  x0_in,
Real const  sd_in 
) [inline]

Referenced by clone().


Member Function Documentation

FuncOP core::scoring::constraints::HarmonicFunc::clone ( ) const [virtual]
Real core::scoring::constraints::HarmonicFunc::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::HarmonicFunc::func ( Real const  const) const [virtual]

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

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

Referenced by show_violations().

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

initialize this Func from the given std::istream.

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

void core::scoring::constraints::HarmonicFunc::sd ( Real  sd) [inline]

References sd().

Real core::scoring::constraints::HarmonicFunc::sd ( ) const [inline]

Referenced by sd().

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

References func().

Real core::scoring::constraints::HarmonicFunc::x0 ( ) const [inline]
void core::scoring::constraints::HarmonicFunc::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