core::scoring::constraints::CircularPowerFunc Class Reference

Generalization of CircularCircularPowerFunc – other exponents allowed. More...

#include <CircularPowerFunc.hh>

Inheritance diagram for core::scoring::constraints::CircularPowerFunc:

Collaboration diagram for core::scoring::constraints::CircularPowerFunc:

Public Member Functions
	CircularPowerFunc (Real const x0_radians, Real const sd_radians, int const power, Real const weight)
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...
Public Member Functions inherited from core::scoring::constraints::Func
virtual	~Func ()
	Automatically generated virtual destructor for class deriving directly from ReferenceCount. More...
virtual void	read_data (std::istream &)
	initialize this Func from the given std::istream. 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 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 r, Size verbose_level, Real threshold=1) const
	show some sort of stringified representation of the violations for this constraint. More...

Private Attributes
Real const	x0_
Real const	sd_
int const	power_
Real const	weight_

Detailed Description

Generalization of CircularCircularPowerFunc – other exponents allowed.

Operates in radians, like DihedralConstraint.

Definition at line 28 of file CircularPowerFunc.hh.

Constructor & Destructor Documentation

core::scoring::constraints::CircularPowerFunc::CircularPowerFunc	(	Real const	x0_radians,
		Real const	sd_radians,
		int const	power,
		Real const	weight
	)

Definition at line 24 of file CircularPowerFunc.cc.

References power_.

Referenced by clone().

Member Function Documentation

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

virtual

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

Definition at line 40 of file CircularPowerFunc.cc.

References CircularPowerFunc().

Real core::scoring::constraints::CircularPowerFunc::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 CircularPowerFunc.cc.

References power_, sd_, weight_, and x0_.

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

References power_, sd_, weight_, and x0_.

Member Data Documentation

int const core::scoring::constraints::CircularPowerFunc::power_

private

Definition at line 45 of file CircularPowerFunc.hh.

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

Real const core::scoring::constraints::CircularPowerFunc::sd_

private

Definition at line 44 of file CircularPowerFunc.hh.

Referenced by dfunc(), and func().

Real const core::scoring::constraints::CircularPowerFunc::weight_

private

Definition at line 46 of file CircularPowerFunc.hh.

Referenced by dfunc(), and func().

Real const core::scoring::constraints::CircularPowerFunc::x0_

private

Definition at line 43 of file CircularPowerFunc.hh.

Referenced by dfunc(), and func().

---

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

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