core::scoring::constraints::ConstantFunc Class Reference

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

#include <ConstantFunc.hh>

Inheritance diagram for core::scoring::constraints::ConstantFunc:

Collaboration diagram for core::scoring::constraints::ConstantFunc:

List of all members.

Public Member Functions
	ConstantFunc (Real const return_val)
FuncOP	clone () const
	returns a clone of this ConstantFunc
Real	func (Real const ) const
	Returns the value of this ConstantFunc evaluated at distance x.
Real	dfunc (Real const ) const
	Returns the value of the first derivative of this ConstantFunc at distance x.
virtual void	show_definition (std::ostream &out) const
	show the definition of this ConstantFunc to the specified output stream.
void	read_data (std::istream &in)
	initialize this Func from the given std::istream.
Friends
std::ostream &	operator<< (std::ostream &out, const ConstantFunc &f)
	Calls show( out ) on this ConstantFunc.

---

Detailed Description

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

---

Constructor & Destructor Documentation

core::scoring::constraints::ConstantFunc::ConstantFunc

(

Real const

return_val

)

[inline]

Referenced by clone().

---

Member Function Documentation

FuncOP core::scoring::constraints::ConstantFunc::clone

(

)

const [inline, virtual]

returns a clone of this ConstantFunc

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

References ConstantFunc().

Real core::scoring::constraints::ConstantFunc::dfunc

(

Real const

)

const [virtual]

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

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

Real core::scoring::constraints::ConstantFunc::func

(

Real const

)

const [virtual]

Returns the value of this ConstantFunc evaluated at distance x.

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

void core::scoring::constraints::ConstantFunc::read_data

(

std::istream &

)

[virtual]

initialize this Func from the given std::istream.

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

void core::scoring::constraints::ConstantFunc::show_definition

(

std::ostream &

out

)

const [virtual]

show the definition of this ConstantFunc to the specified output stream.

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

---

Friends And Related Function Documentation

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

Calls show( out ) on this ConstantFunc.

---

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

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