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

#include <FadeFunc.hh>

Inheritance diagram for core::scoring::constraints::FadeFunc:

Inheritance graph

Collaboration diagram for core::scoring::constraints::FadeFunc:

Collaboration graph

Public Member Functions
	FadeFunc (Real const cutoff_lower, Real const cutoff_upper, Real const fade_zone, Real const well_depth, Real const well_offset)

	FadeFunc (Real const cutoff_lower, Real const cutoff_upper, Real const fade_zone, Real const well_depth)

	FadeFunc (Real const cutoff_lower, Real const cutoff_upper, Real const fade_zone)

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	cutoff_upper () const

Real	cutoff_lower () const

Real	fade_zone () const

void	cutoff_upper (Real x)

void	cutoff_lower (Real x)

void	fade_zone (Real x)

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	cutoff_lower_

Real	cutoff_upper_

Real	fade_zone_

Real	well_depth_

Real	well_offset_

Detailed Description

Definition at line 32 of file FadeFunc.hh.

Constructor & Destructor Documentation

core::scoring::constraints::FadeFunc::FadeFunc	(	Real const	cutoff_lower,
		Real const	cutoff_upper,
		Real const	fade_zone,
		Real const	well_depth,
		Real const	well_offset
	)

inline

Definition at line 36 of file FadeFunc.hh.

Referenced by clone().

core::scoring::constraints::FadeFunc::FadeFunc	(	Real const	cutoff_lower,
		Real const	cutoff_upper,
		Real const	fade_zone,
		Real const	well_depth
	)

inline

Definition at line 45 of file FadeFunc.hh.

core::scoring::constraints::FadeFunc::FadeFunc	(	Real const	cutoff_lower,
		Real const	cutoff_upper,
		Real const	fade_zone
	)

inline

Definition at line 53 of file FadeFunc.hh.

Member Function Documentation

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

virtual

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

Definition at line 34 of file FadeFunc.cc.

References cutoff_lower_, cutoff_upper_, fade_zone_, FadeFunc(), well_depth_, and well_offset_.

Real core::scoring::constraints::FadeFunc::cutoff_lower ( ) const

inline

Definition at line 72 of file FadeFunc.hh.

References cutoff_lower_.

void core::scoring::constraints::FadeFunc::cutoff_lower ( Real x)

inline

Definition at line 76 of file FadeFunc.hh.

References cutoff_lower_.

Real core::scoring::constraints::FadeFunc::cutoff_upper ( ) const

inline

Definition at line 71 of file FadeFunc.hh.

References cutoff_upper_.

void core::scoring::constraints::FadeFunc::cutoff_upper ( Real x)

inline

Definition at line 75 of file FadeFunc.hh.

References cutoff_upper_.

Real core::scoring::constraints::FadeFunc::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 70 of file FadeFunc.cc.

References protocols::match::upstream::b, cutoff_lower_, cutoff_upper_, fade_zone_, and well_depth_.

Real core::scoring::constraints::FadeFunc::fade_zone ( ) const

inline

Definition at line 73 of file FadeFunc.hh.

References fade_zone_.

void core::scoring::constraints::FadeFunc::fade_zone ( Real x)

inline

Definition at line 77 of file FadeFunc.hh.

References fade_zone_.

Real core::scoring::constraints::FadeFunc::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 42 of file FadeFunc.cc.

References protocols::match::upstream::b, cutoff_lower_, cutoff_upper_, fade_zone_, well_depth_, and well_offset_.

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

virtual

initialize this Func from the given std::istream.

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

Definition at line 97 of file FadeFunc.cc.

References cutoff_lower_, cutoff_upper_, fade_zone_, well_depth_, and well_offset_.

void core::scoring::constraints::FadeFunc::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 106 of file FadeFunc.cc.

References cutoff_lower_, cutoff_upper_, fade_zone_, well_depth_, and well_offset_.

Size core::scoring::constraints::FadeFunc::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 116 of file FadeFunc.cc.

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

Member Data Documentation

Real core::scoring::constraints::FadeFunc::cutoff_lower_

private

Definition at line 83 of file FadeFunc.hh.

Referenced by clone(), cutoff_lower(), dfunc(), func(), read_data(), and show_definition().

Real core::scoring::constraints::FadeFunc::cutoff_upper_

private

Definition at line 84 of file FadeFunc.hh.

Referenced by clone(), cutoff_upper(), dfunc(), func(), read_data(), show_definition(), and show_violations().

Real core::scoring::constraints::FadeFunc::fade_zone_

private

Definition at line 85 of file FadeFunc.hh.

Referenced by clone(), dfunc(), fade_zone(), func(), read_data(), and show_definition().

Real core::scoring::constraints::FadeFunc::well_depth_

private

Definition at line 86 of file FadeFunc.hh.

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

Real core::scoring::constraints::FadeFunc::well_offset_

private

Definition at line 87 of file FadeFunc.hh.

Referenced by clone(), func(), read_data(), and show_definition().

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

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