a variant of the bound func that is periodic More...

#include <BoundConstraint.hh>

Inheritance diagram for core::scoring::constraints::PeriodicBoundFunc:

Collaboration diagram for core::scoring::constraints::PeriodicBoundFunc:

Public Types
typedef BoundFunc	parent

Public Member Functions
	PeriodicBoundFunc (Real const lb, Real const ub, Real sd, std::string type, Real const periodicity_in)

FuncOP	clone () const

void	read_data (std::istream &)
	initialize this Func from the given std::istream. More...

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	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::BoundFunc
	BoundFunc (Real const lb, Real const ub, Real sd, std::string type)

	BoundFunc (Real const lb, Real const ub, Real sd, Real rswitch, std::string type)

Real	lb () const

Real	ub () const

Real	sd () const

Real	rswitch () const

std::string	type () const

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	periodicity_

Detailed Description

a variant of the bound func that is periodic

Definition at line 84 of file BoundConstraint.hh.

Member Typedef Documentation

typedef BoundFunc core::scoring::constraints::PeriodicBoundFunc::parent

Definition at line 87 of file BoundConstraint.hh.

Constructor & Destructor Documentation

core::scoring::constraints::PeriodicBoundFunc::PeriodicBoundFunc	(	Real const	lb,
		Real const	ub,
		Real	sd,
		std::string	type,
		Real const	periodicity_in
	)

inline

Definition at line 90 of file BoundConstraint.hh.

Referenced by clone().

Member Function Documentation

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

inlinevirtual

Reimplemented from core::scoring::constraints::BoundFunc.

Definition at line 101 of file BoundConstraint.hh.

References PeriodicBoundFunc().

Real core::scoring::constraints::PeriodicBoundFunc::dfunc ( Real const const) const

inlinevirtual

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

Reimplemented from core::scoring::constraints::BoundFunc.

Definition at line 110 of file BoundConstraint.hh.

References core::scoring::constraints::BoundFunc::dfunc(), and periodicity_.

Real core::scoring::constraints::PeriodicBoundFunc::func ( Real const const) const

inlinevirtual

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

Reimplemented from core::scoring::constraints::BoundFunc.

Definition at line 105 of file BoundConstraint.hh.

References core::scoring::constraints::BoundFunc::func(), and periodicity_.

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

virtual

initialize this Func from the given std::istream.

Reimplemented from core::scoring::constraints::BoundFunc.

Definition at line 151 of file BoundConstraint.cc.

void core::scoring::constraints::PeriodicBoundFunc::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::BoundFunc.

Definition at line 143 of file BoundConstraint.cc.

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

inlinevirtual

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

Reimplemented from core::scoring::constraints::BoundFunc.

Definition at line 117 of file BoundConstraint.hh.

References periodicity_, and core::scoring::constraints::BoundFunc::show_violations().

Member Data Documentation

Real core::scoring::constraints::PeriodicBoundFunc::periodicity_

private

Definition at line 123 of file BoundConstraint.hh.

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

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

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

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation