#include <LinearPenaltyFunction.hh>

Inheritance diagram for core::scoring::constraints::LinearPenaltyFunction:

Collaboration diagram for core::scoring::constraints::LinearPenaltyFunction:

Public Member Functions
	LinearPenaltyFunction (Real const x_middle, Real const well_depth, Real const half_width, Real const slope)

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	get_x_middle () const

Real	get_well_depth () const

Real	get_half_width () const

Real	get_slope () const

void	set_x_middle (Real x)

void	set_well_depth (Real well_depth)

void	set_half_width (Real half_width)

void	set_slope (Real slope)

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	x_middle_

Real	well_depth_

Real	half_width_

Real	slope_

Detailed Description

Definition at line 30 of file LinearPenaltyFunction.hh.

Constructor & Destructor Documentation

core::scoring::constraints::LinearPenaltyFunction::LinearPenaltyFunction	(	Real const	x_middle,
		Real const	well_depth,
		Real const	half_width,
		Real const	slope
	)

inline

Definition at line 32 of file LinearPenaltyFunction.hh.

Referenced by clone().

Member Function Documentation

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

inlinevirtual

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

Definition at line 36 of file LinearPenaltyFunction.hh.

References LinearPenaltyFunction().

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

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

References half_width_, slope_, well_depth_, and x_middle_.

Real core::scoring::constraints::LinearPenaltyFunction::get_half_width ( ) const

inline

Definition at line 47 of file LinearPenaltyFunction.hh.

References half_width_.

Real core::scoring::constraints::LinearPenaltyFunction::get_slope ( ) const

inline

Definition at line 48 of file LinearPenaltyFunction.hh.

References slope_.

Real core::scoring::constraints::LinearPenaltyFunction::get_well_depth ( ) const

inline

Definition at line 46 of file LinearPenaltyFunction.hh.

References well_depth_.

Real core::scoring::constraints::LinearPenaltyFunction::get_x_middle ( ) const

inline

Definition at line 45 of file LinearPenaltyFunction.hh.

References x_middle_.

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

virtual

initialize this Func from the given std::istream.

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

Definition at line 43 of file LinearPenaltyFunction.cc.

References half_width_, slope_, well_depth_, and x_middle_.

void core::scoring::constraints::LinearPenaltyFunction::set_half_width ( Real half_width)

inline

Definition at line 51 of file LinearPenaltyFunction.hh.

References half_width_.

void core::scoring::constraints::LinearPenaltyFunction::set_slope ( Real slope)

inline

Definition at line 52 of file LinearPenaltyFunction.hh.

References slope_.

void core::scoring::constraints::LinearPenaltyFunction::set_well_depth ( Real well_depth)

inline

Definition at line 50 of file LinearPenaltyFunction.hh.

References well_depth_.

void core::scoring::constraints::LinearPenaltyFunction::set_x_middle ( Real x)

inline

Definition at line 49 of file LinearPenaltyFunction.hh.

References x_middle_.

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

References half_width_, slope_, well_depth_, and x_middle_.

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