Class for representing arbitrarily defined functions. More...

#include <EtableFunc.hh>

Inheritance diagram for core::scoring::func::EtableFunc:

Public Member Functions
	EtableFunc (Real const min, Real const max, Real const stepsize)

FuncOP	clone () const override
	returns a clone of this EtableFunc 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 x) const override
	Returns the value of this EtableFunc evaluated at distance x. More...

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

void	show_definition (std::ostream &out) const override
	show the definitio of this EtableFunc 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
utility::vector1< core::Real >	func_

core::Real	min_

core::Real	max_

core::Real	stepsize_

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

Detailed Description

Class for representing arbitrarily defined functions.

Constructor & Destructor Documentation

core::scoring::func::EtableFunc::EtableFunc	(	Real const	min,
		Real const	max,
		Real const	stepsize
	)

inline

Constuctor for EtableFunc. Arguments to the constructor are:

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

Member Function Documentation

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

inlineoverridevirtual

returns a clone of this EtableFunc

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

Real core::scoring::func::EtableFunc::dfunc ( Real const x ) const

overridevirtual

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

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

Real core::scoring::func::EtableFunc::func ( Real const x ) const

overridevirtual

Returns the value of this EtableFunc evaluated at distance x.

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

References core::scoring::constraints::linear_interpolate().

bool core::scoring::func::EtableFunc::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 core::scoring::func::Func::same_type_as_me().

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

overridevirtual

initialize this Func from the given std::istream.

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

bool core::scoring::func::EtableFunc::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.

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

overridevirtual

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

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

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	out,
		const EtableFunc &	f
	)

friend

Calls show( out ) on this EtableFunc.

Member Data Documentation

utility::vector1< core::Real > core::scoring::func::EtableFunc::func_

private

core::Real core::scoring::func::EtableFunc::max_

private

core::Real core::scoring::func::EtableFunc::min_

private

core::Real core::scoring::func::EtableFunc::stepsize_

private

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

src/core/scoring/func/EtableFunc.hh
src/core/scoring/func/EtableFunc.cc

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation