#include <FlatHarmonicFunc.hh>

Inheritance diagram for core::scoring::constraints::FlatHarmonicFunc:

Collaboration diagram for core::scoring::constraints::FlatHarmonicFunc:

Public Member Functions
	FlatHarmonicFunc (Real const x0_in, Real const sd_in, Real const tol_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	sd () const

Real	tol () const

void	x0 (Real x)

void	sd (Real sd)

void	tol (Real tol)

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	sd_

Real	tol_

Detailed Description

Definition at line 27 of file FlatHarmonicFunc.hh.

Constructor & Destructor Documentation

core::scoring::constraints::FlatHarmonicFunc::FlatHarmonicFunc	(	Real const	x0_in,
		Real const	sd_in,
		Real const	tol_in
	)

inline

Definition at line 29 of file FlatHarmonicFunc.hh.

Referenced by clone().

Member Function Documentation

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

inlinevirtual

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

Definition at line 32 of file FlatHarmonicFunc.hh.

References FlatHarmonicFunc().

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

References sd_, tol_, and x0_.

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

References sd_, tol_, and x0_.

Referenced by show_violations().

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

virtual

initialize this Func from the given std::istream.

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

Definition at line 59 of file FlatHarmonicFunc.cc.

References sd_, tol_, and x0_.

Real core::scoring::constraints::FlatHarmonicFunc::sd ( ) const

inline

Definition at line 45 of file FlatHarmonicFunc.hh.

References sd_.

Referenced by sd().

void core::scoring::constraints::FlatHarmonicFunc::sd ( Real sd)

inline

Definition at line 57 of file FlatHarmonicFunc.hh.

References sd(), and sd_.

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

References sd_, tol_, and x0_.

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

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

Real core::scoring::constraints::FlatHarmonicFunc::tol ( ) const

inline

Definition at line 49 of file FlatHarmonicFunc.hh.

References tol_.

Referenced by tol().

void core::scoring::constraints::FlatHarmonicFunc::tol ( Real tol)

inline

Definition at line 61 of file FlatHarmonicFunc.hh.

References tol(), and tol_.

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

inline

Definition at line 41 of file FlatHarmonicFunc.hh.

References x0_.

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

inline

Definition at line 53 of file FlatHarmonicFunc.hh.

References x0_.

Member Data Documentation

Real core::scoring::constraints::FlatHarmonicFunc::sd_

private

Definition at line 70 of file FlatHarmonicFunc.hh.

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

Real core::scoring::constraints::FlatHarmonicFunc::tol_

private

Definition at line 71 of file FlatHarmonicFunc.hh.

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

Real core::scoring::constraints::FlatHarmonicFunc::x0_

private

Definition at line 69 of file FlatHarmonicFunc.hh.

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

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

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation