core::scoring::constraints::TopOutFunc Class Reference

#include <TopOutFunc.hh>

Inheritance diagram for core::scoring::constraints::TopOutFunc:

Collaboration diagram for core::scoring::constraints::TopOutFunc:

Public Member Functions
	TopOutFunc (Real weight_in, Real x0_in, Real limit_in)
FuncOP	clone () const
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	read_data (std::istream &in)
	initialize this Func from the given std::istream. 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...
Real	x0 () const
Real	limit () const
Real	weight () const
void	x0 (Real x)
void	limit (Real limit)
void	weight (Real weight)
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. 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...

Private Attributes
Real	x0_
Real	weight_
Real	limit_

Detailed Description

Definition at line 28 of file TopOutFunc.hh.

Constructor & Destructor Documentation

core::scoring::constraints::TopOutFunc::TopOutFunc ( Real  weight_in, Real  x0_in, Real  limit_in  )

inline

Definition at line 30 of file TopOutFunc.hh.

Referenced by clone().

Member Function Documentation

FuncOP core::scoring::constraints::TopOutFunc::clone ( ) const

inlinevirtual

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

Definition at line 34 of file TopOutFunc.hh.

References TopOutFunc().

Real core::scoring::constraints::TopOutFunc::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.

Definition at line 37 of file TopOutFunc.cc.

References limit_, weight_, and x0_.

Real core::scoring::constraints::TopOutFunc::func ( Real const  const) const

virtual

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

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

Definition at line 29 of file TopOutFunc.cc.

References limit_, weight_, and x0_.

Referenced by show_violations().

Real core::scoring::constraints::TopOutFunc::limit ( ) const

inline

Definition at line 44 of file TopOutFunc.hh.

References limit_.

void core::scoring::constraints::TopOutFunc::limit ( Real  limit)

inline

Definition at line 48 of file TopOutFunc.hh.

References limit(), and limit_.

Referenced by limit().

void core::scoring::constraints::TopOutFunc::read_data ( std::istream &  )

virtual

initialize this Func from the given std::istream.

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

Definition at line 45 of file TopOutFunc.cc.

References limit_, weight_, and x0_.

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

Definition at line 50 of file TopOutFunc.cc.

References limit_, weight_, and x0_.

Size core::scoring::constraints::TopOutFunc::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.

Definition at line 55 of file TopOutFunc.cc.

References func(), and core::scoring::constraints::Func::show_violations().

Real core::scoring::constraints::TopOutFunc::weight ( ) const

inline

Definition at line 45 of file TopOutFunc.hh.

References weight_.

void core::scoring::constraints::TopOutFunc::weight ( Real  weight)

inline

Definition at line 49 of file TopOutFunc.hh.

References weight(), and weight_.

Referenced by weight().

Real core::scoring::constraints::TopOutFunc::x0 ( ) const

inline

Definition at line 43 of file TopOutFunc.hh.

References x0_.

void core::scoring::constraints::TopOutFunc::x0 ( Real  x)

inline

Definition at line 47 of file TopOutFunc.hh.

References x0_.

Member Data Documentation

Real core::scoring::constraints::TopOutFunc::limit_

private

Definition at line 57 of file TopOutFunc.hh.

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

Real core::scoring::constraints::TopOutFunc::weight_

private

Definition at line 56 of file TopOutFunc.hh.

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

Real core::scoring::constraints::TopOutFunc::x0_

private

Definition at line 55 of file TopOutFunc.hh.

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

---

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

• src/core/scoring/constraints/TopOutFunc.hh
• src/core/scoring/constraints/TopOutFunc.cc