core::scoring::constraints::GaussianFunc Class Reference

Derived class of class Func representing a Gaussian distribution with a user-specified mean and standard deviation. More...

#include <GaussianFunc.hh>

Inheritance diagram for core::scoring::constraints::GaussianFunc:

Collaboration diagram for core::scoring::constraints::GaussianFunc:

List of all members.

Public Member Functions
	GaussianFunc (Real const mean, Real const sd)
FuncOP	clone () const
	returns a clone of this GaussianFunc
Real	func (Real const x) const
	Returns the value of this GaussianFunc evaluated at distance x.
Real	dfunc (Real const x) const
	Returns the value of the first derivative of this GaussianFunc at distance x.
virtual void	show_definition (std::ostream &out) const
	show the definitio of this GaussianFunc to the specified output stream.
void	read_data (std::istream &in)
	The parameters are:
Friends
std::ostream &	operator<< (std::ostream &out, const GaussianFunc &f)
	Calls show( out ) on this GaussianFunc.

---

Detailed Description

Derived class of class Func representing a Gaussian distribution with a user-specified mean and standard deviation.

---

Constructor & Destructor Documentation

core::scoring::constraints::GaussianFunc::GaussianFunc	(	Real const	mean,
		Real const	sd
	)		[inline]

Constuctor for GaussianFunc. Arguments to the constructor are:

• mean: parameter representing the mean of this function.
• sd: parameter representing the standard deviation of this function.

Referenced by clone().

---

Member Function Documentation

FuncOP core::scoring::constraints::GaussianFunc::clone

(

)

const [inline, virtual]

returns a clone of this GaussianFunc

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

References GaussianFunc().

Real core::scoring::constraints::GaussianFunc::dfunc

(

Real const

x

)

const [virtual]

Returns the value of the first derivative of this GaussianFunc at distance x.

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

References core::scoring::constraints::gaussian_deriv(), and core::scoring::constraints::logdgaussian_deriv().

Real core::scoring::constraints::GaussianFunc::func

(

Real const

x

)

const [virtual]

Returns the value of this GaussianFunc evaluated at distance x.

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

References core::scoring::constraints::dgaussian(), and core::scoring::constraints::logdgaussian().

Referenced by core::scoring::methods::PeptideBondEnergy::residue_pair_energy().

void core::scoring::constraints::GaussianFunc::read_data

(

std::istream &

in

)

[virtual]

The parameters are:

Initializes this GaussianFunc from the given istream. An example of the type of string from which the istream should be constructed is: "GAUSSIANFUNC 19.396 7.643". The interpretation is to create initialize this GaussianFunc object with the following parameters:

• mean 19.396
• sd 7.643

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

void core::scoring::constraints::GaussianFunc::show_definition

(

std::ostream &

out

)

const [virtual]

show the definitio of this GaussianFunc to the specified output stream.

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

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	out,
		const GaussianFunc &	f
	)		[friend]

Calls show( out ) on this GaussianFunc.

---

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

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