core::scoring::constraints::PeriodicFunc Class Reference

function of type y = ( k * cos(n * (x - x0) ) ) + C More...

#include <PeriodicFunc.hh>

Inheritance diagram for core::scoring::constraints::PeriodicFunc:

Collaboration diagram for core::scoring::constraints::PeriodicFunc:

List of all members.

Public Member Functions
	PeriodicFunc (Real const x0_in, Real const k_in, Real const n_periodic_in, Real const C_in)
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.
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.

---

Detailed Description

function of type y = ( k * cos(n * (x - x0) ) ) + C

---

Constructor & Destructor Documentation

core::scoring::constraints::PeriodicFunc::PeriodicFunc	(	Real const	x0_in,
		Real const	k_in,
		Real const	n_periodic_in,
		Real const	C_in
	)		[inline]

Referenced by clone().

---

Member Function Documentation

FuncOP core::scoring::constraints::PeriodicFunc::clone

(

)

const [inline, virtual]

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

References PeriodicFunc().

Real core::scoring::constraints::PeriodicFunc::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::PeriodicFunc::func

(

Real const

const

)

const [virtual]

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

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

Referenced by show_violations().

void core::scoring::constraints::PeriodicFunc::read_data

(

std::istream &

)

[virtual]

initialize this Func from the given std::istream.

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

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

References func().

---

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

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