core::scoring::func::LinearPenaltyFunction Class Reference

#include <LinearPenaltyFunction.hh>

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::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	x_middle_
Real	well_depth_
Real	half_width_
Real	slope_

Constructor & Destructor Documentation

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

inline

Referenced by clone().

Member Function Documentation

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

inlinevirtual

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

References LinearPenaltyFunction().

Real core::scoring::func::LinearPenaltyFunction::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.

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

virtual

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

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

References half_width_, slope_, well_depth_, and x_middle_.

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

inline

References half_width_.

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

inline

References slope_.

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

inline

References well_depth_.

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

inline

References x_middle_.

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

virtual

initialize this Func from the given std::istream.

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

References half_width_, slope_, well_depth_, and x_middle_.

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

inline

References half_width_.

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

inline

References slope_.

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

inline

References well_depth_.

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

inline

References x_middle_.

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

References half_width_, slope_, well_depth_, and x_middle_.

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

virtual

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

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

References core::scoring::func::Func::show_violations(), and x_middle_.

Member Data Documentation

Real core::scoring::func::LinearPenaltyFunction::half_width_

private

Referenced by func(), get_half_width(), read_data(), set_half_width(), and show_definition().

Real core::scoring::func::LinearPenaltyFunction::slope_

private

Referenced by func(), get_slope(), read_data(), set_slope(), and show_definition().

Real core::scoring::func::LinearPenaltyFunction::well_depth_

private

Referenced by func(), get_well_depth(), read_data(), set_well_depth(), and show_definition().

Real core::scoring::func::LinearPenaltyFunction::x_middle_

private

Referenced by func(), get_x_middle(), read_data(), set_x_middle(), show_definition(), and show_violations().

---

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

• symlinks/rosetta/src/core/scoring/func/LinearPenaltyFunction.hh
• symlinks/rosetta/src/core/scoring/func/LinearPenaltyFunction.cc