core::scoring::constraints::ScalarWeightedFunc Class Reference

#include <ScalarWeightedFunc.hh>

Inheritance diagram for core::scoring::constraints::ScalarWeightedFunc:

Collaboration diagram for core::scoring::constraints::ScalarWeightedFunc:

Public Member Functions
	ScalarWeightedFunc (Real const weight, FuncOP myfunc)
virtual	~ScalarWeightedFunc ()
virtual FuncOP	clone () const
virtual Real	func (Real const x) const
	Returns a value representing this function evaluated at a given point. More...
virtual Real	dfunc (Real const x) const
	Returns a value representing the derivative of this function evaluated at a given point. More...
virtual void	read_data (std::istream &)
	initialize this Func from the given std::istream. 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...
virtual Size	show_violations (std::ostream &out, Real x, Size verbose_level, 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	weight_
FuncOP	func_to_weight_

Detailed Description

Definition at line 38 of file ScalarWeightedFunc.hh.

Constructor & Destructor Documentation

core::scoring::constraints::ScalarWeightedFunc::ScalarWeightedFunc ( Real const  weight, FuncOP  myfunc  )

inline

Definition at line 40 of file ScalarWeightedFunc.hh.

Referenced by clone().

core::scoring::constraints::ScalarWeightedFunc::~ScalarWeightedFunc ( )

virtual

Definition at line 38 of file ScalarWeightedFunc.cc.

Member Function Documentation

virtual FuncOP core::scoring::constraints::ScalarWeightedFunc::clone ( ) const

inlinevirtual

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

Definition at line 49 of file ScalarWeightedFunc.hh.

References ScalarWeightedFunc().

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

References func_to_weight_, and weight_.

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

References func_to_weight_, and weight_.

Referenced by show_violations().

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

virtual

initialize this Func from the given std::istream.

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

Definition at line 55 of file ScalarWeightedFunc.cc.

References func_to_weight_, core::scoring::constraints::FuncFactory::func_types_, and weight_.

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

References func_to_weight_, and weight_.

Size core::scoring::constraints::ScalarWeightedFunc::show_violations ( std::ostream &  out, Real  r, Size  verbose_level, 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 75 of file ScalarWeightedFunc.cc.

References func(), func_to_weight_, and weight_.

Member Data Documentation

FuncOP core::scoring::constraints::ScalarWeightedFunc::func_to_weight_

private

Definition at line 67 of file ScalarWeightedFunc.hh.

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

Real core::scoring::constraints::ScalarWeightedFunc::weight_

private

Definition at line 66 of file ScalarWeightedFunc.hh.

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

---

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

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