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::func::ConstantFunc:

[legend]

Public Member Functions
	ConstantFunc (Real const return_val)

FuncOP	clone () const override
	returns a clone of this ConstantFunc More...

bool	operator== (Func const &other) const override
	Equality operator. Looks for strict equality. Floating-point comparison is the rule rather than the exception. More...

bool	same_type_as_me (Func const &other) const override
	Does the input Func, "other", have the same type as me? Necessary for the equality operator to function correctly. All derived Func classes must implement this function. More...

Real	func (Real const ) const override
	Returns the value of this ConstantFunc evaluated at distance x. More...

Real	dfunc (Real const ) const override
	Returns the value of the first derivative of this ConstantFunc at distance x. More...

void	show_definition (std::ostream &out) const override
	show the definition of this ConstantFunc to the specified output stream. More...

void	read_data (std::istream &in) override
	initialize this Func from the given std::istream. More...

Public Member Functions inherited from core::scoring::func::Func
	~Func () override
	Automatically generated virtual destructor for class deriving directly from VirtualBase. More...

bool	operator!= (Func const &other) const
	inequality operator – simply the negation of the (virtual) equality operator 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...

virtual Size	show_violations (std::ostream &out, Real r, Size verbose_level, Real threshold=1) const
	show some sort of stringified representation of the violations for this constraint. More...

Private Attributes
Real	return_val_

Friends
std::ostream &	operator<< (std::ostream &out, const ConstantFunc &f)
	Calls show( out ) on this ConstantFunc. More...

Detailed Description

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

Constructor & Destructor Documentation

core::scoring::func::ConstantFunc::ConstantFunc ( Real const return_val )

inline

Member Function Documentation

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

inlineoverridevirtual

returns a clone of this ConstantFunc

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

Real core::scoring::func::ConstantFunc::dfunc ( Real const ) const

overridevirtual

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

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

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

overridevirtual

Returns the value of this ConstantFunc evaluated at distance x.

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

References return_val_.

bool core::scoring::func::ConstantFunc::operator== ( Func const & other ) const

overridevirtual

Equality operator. Looks for strict equality. Floating-point comparison is the rule rather than the exception.

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

References return_val_, same_type_as_me(), and core::scoring::func::Func::same_type_as_me().

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

overridevirtual

initialize this Func from the given std::istream.

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

References return_val_.

bool core::scoring::func::ConstantFunc::same_type_as_me ( Func const & other ) const

overridevirtual

Does the input Func, "other", have the same type as me? Necessary for the equality operator to function correctly. All derived Func classes must implement this function.

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

Referenced by operator==().

void core::scoring::func::ConstantFunc::show_definition ( std::ostream & out ) const

overridevirtual

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

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

References return_val_.