Rosetta 3.5: core::scoring::constraints::SoedingFunc Class Reference

Derived class of class Func representing a Soeding distribution with a user-specified mean and standard deviation. More...

#include <SoedingFunc.hh>

Inheritance diagram for core::scoring::constraints::SoedingFunc:

Inheritance graph

Collaboration diagram for core::scoring::constraints::SoedingFunc:

Collaboration graph

Public Member Functions
	SoedingFunc ()

FuncOP	clone () const
	returns a clone of this SoedingFunc More...

Real	compute_func (Real const x) const

Real	func (Real const x) const
	Returns the value of this SoedingFunc evaluated at distance x. More...

Real	dfunc (Real const x) const
	Returns the value of the first derivative of this SoedingFunc at distance x. More...

virtual void	show_definition (std::ostream &out) const
	show the definition of this SoedingFunc to the specified output stream. More...

void	read_data (std::istream &in)
	Initializes this SoedingFunc from the given istream. 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...

virtual Size	show_violations (std::ostream &out, Real r, Size verbose_level, Real threshold=1) const
	show some sort of stringified representation of the violations for this constraint. More...

Private Attributes
Real	w1_

Real	mean1_

Real	sdev1_

Real	w2_

Real	mean2_

Real	sdev2_

Friends
std::ostream &	operator<< (std::ostream &out, const SoedingFunc &f)
	Calls show( out ) on this SoedingFunc. More...

Detailed Description

Derived class of class Func representing a Soeding distribution with a user-specified mean and standard deviation.

Definition at line 28 of file SoedingFunc.hh.

Constructor & Destructor Documentation

core::scoring::constraints::SoedingFunc::SoedingFunc ( )

inline

Definition at line 31 of file SoedingFunc.hh.

Referenced by clone().

Member Function Documentation

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

inlinevirtual

returns a clone of this SoedingFunc

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

Definition at line 36 of file SoedingFunc.hh.

References SoedingFunc().

Real core::scoring::constraints::SoedingFunc::compute_func ( Real const x) const

Definition at line 41 of file SoedingFunc.cc.

References core::scoring::constraints::dgaussian(), mean1_, mean2_, sdev1_, sdev2_, w1_, and w2_.

Referenced by func().

Real core::scoring::constraints::SoedingFunc::dfunc ( Real const x) const

virtual

Returns the value of the first derivative of this SoedingFunc at distance x.

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

Definition at line 72 of file SoedingFunc.cc.

References core::scoring::constraints::Func::estimate_dfunc().

Real core::scoring::constraints::SoedingFunc::func ( Real const x) const

virtual

Returns the value of this SoedingFunc evaluated at distance x.

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

Definition at line 58 of file SoedingFunc.cc.

References compute_func(), and core::pack::interaction_graph::debug.

void core::scoring::constraints::SoedingFunc::read_data ( std::istream & in)

virtual

Initializes this SoedingFunc from the given istream.

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

Definition at line 36 of file SoedingFunc.cc.

References mean1_, mean2_, sdev1_, sdev2_, w1_, and w2_.

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

virtual

show the definition of this SoedingFunc to the specified output stream.

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

Definition at line 76 of file SoedingFunc.cc.

References mean1_, mean2_, sdev1_, sdev2_, w1_, and w2_.

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	out,
		const SoedingFunc &	f
	)

friend

Calls show( out ) on this SoedingFunc.

Definition at line 51 of file SoedingFunc.hh.

Member Data Documentation

Real core::scoring::constraints::SoedingFunc::mean1_

private

Definition at line 60 of file SoedingFunc.hh.

Referenced by compute_func(), read_data(), and show_definition().

Real core::scoring::constraints::SoedingFunc::mean2_

private

Definition at line 60 of file SoedingFunc.hh.

Referenced by compute_func(), read_data(), and show_definition().

Real core::scoring::constraints::SoedingFunc::sdev1_

private

Definition at line 60 of file SoedingFunc.hh.

Referenced by compute_func(), read_data(), and show_definition().

Real core::scoring::constraints::SoedingFunc::sdev2_

private

Definition at line 60 of file SoedingFunc.hh.

Referenced by compute_func(), read_data(), and show_definition().

Real core::scoring::constraints::SoedingFunc::w1_

private

Definition at line 60 of file SoedingFunc.hh.

Referenced by compute_func(), read_data(), and show_definition().

Real core::scoring::constraints::SoedingFunc::w2_

private

Definition at line 60 of file SoedingFunc.hh.

Referenced by compute_func(), read_data(), and show_definition().

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

src/core/scoring/constraints/SoedingFunc.hh
src/core/scoring/constraints/SoedingFunc.cc