core::scoring::constraints::LinearPenaltyFunction Class Reference

#include <LinearPenaltyFunction.hh>

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

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

List of all members.

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.
Real	dfunc (Real const x) const
	Returns a value representing the derivative of this function evaluated at a given point.
void	read_data (std::istream &in)
	initialize this Func from the given std::istream.
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.
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.

---

Constructor & Destructor Documentation

core::scoring::constraints::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::constraints::LinearPenaltyFunction::clone

(

)

const [inline, virtual]

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

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.

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.

Real core::scoring::constraints::LinearPenaltyFunction::get_half_width

(

)

const [inline]

Real core::scoring::constraints::LinearPenaltyFunction::get_slope

(

)

const [inline]

Real core::scoring::constraints::LinearPenaltyFunction::get_well_depth

(

)

const [inline]

Real core::scoring::constraints::LinearPenaltyFunction::get_x_middle

(

)

const [inline]

void core::scoring::constraints::LinearPenaltyFunction::read_data

(

std::istream &

)

[virtual]

initialize this Func from the given std::istream.

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

void core::scoring::constraints::LinearPenaltyFunction::set_half_width

(

Real

half_width

)

[inline]

void core::scoring::constraints::LinearPenaltyFunction::set_slope

(

Real

slope

)

[inline]

void core::scoring::constraints::LinearPenaltyFunction::set_well_depth

(

Real

well_depth

)

[inline]

void core::scoring::constraints::LinearPenaltyFunction::set_x_middle

(

Real

x

)

[inline]

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.

Size core::scoring::constraints::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::constraints::Func.

---

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

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