Rosetta Core: core::scoring::func::SkipViolFunc Class Reference

Rosetta Core 2014.35

#include <SkipViolFunc.hh>

Public Member Functions
	SkipViolFunc (Real const weight, FuncOP myfunc)

	~SkipViolFunc ()

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 &)
	initialize this Func from the given std::istream. More...

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

virtual 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...

Size	viols () const

Public Member Functions inherited from core::scoring::func::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	weight_

core::Size	count_viols_

FuncOP	func_to_weight_

Constructor & Destructor Documentation

core::scoring::func::SkipViolFunc::SkipViolFunc	(	Real const	weight,
		FuncOP	myfunc
	)

inline

Referenced by clone().

core::scoring::func::SkipViolFunc::~SkipViolFunc ( )

inline

Member Function Documentation

FuncOP core::scoring::func::SkipViolFunc::clone ( ) const

inlinevirtual

Implements core::scoring::func::Func.

References SkipViolFunc().

Real core::scoring::func::SkipViolFunc::dfunc ( Real const const ) const

virtual

Returns a value representing the derivative of this function evaluated at a given point.

Implements core::scoring::func::Func.

References func_to_weight_, and weight_.

Real core::scoring::func::SkipViolFunc::func ( Real const const ) const

virtual

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

Implements core::scoring::func::Func.

References func_to_weight_, and weight_.

void core::scoring::func::SkipViolFunc::read_data ( std::istream & )

virtual

initialize this Func from the given std::istream.

Reimplemented from core::scoring::func::Func.

References count_viols_, func_to_weight_, core::scoring::func::FuncFactory::func_types_, and weight_.

void core::scoring::func::SkipViolFunc::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::func::Func.

References count_viols_, and func_to_weight_.

core::Size core::scoring::func::SkipViolFunc::show_violations	(	std::ostream &	out,
		Real	r,
		core::Size	verbose_level,
		Real	threshold = `1`
	)		const

virtual

show some sort of stringified representation of the violations for this constraint.

Reimplemented from core::scoring::func::Func.

References func_to_weight_.

Size core::scoring::func::SkipViolFunc::viols ( ) const

inline

References count_viols_.

Member Data Documentation

core::Size core::scoring::func::SkipViolFunc::count_viols_

private

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

FuncOP core::scoring::func::SkipViolFunc::func_to_weight_

private

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

Real core::scoring::func::SkipViolFunc::weight_

private

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

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

src/core/scoring/func/SkipViolFunc.hh
src/core/scoring/func/SkipViolFunc.cc