Function that allows return of arbitrary FArrays – this time circularized. More...

#include <CircularGeneral1D_Func.hh>

Inheritance diagram for core::scoring::func::CircularGeneral1D_Func:

Public Member Functions
	CircularGeneral1D_Func (ObjexxFCL::FArray1D< core::Real > const &data, core::Real const &xmin, core::Real const &xbin)

	CircularGeneral1D_Func (std::string const &filename)

FuncOP	clone () const override
	This method must return a deep copy of this Func, meaning if this Func holds pointers to other Func objects, that it must clone those Func objects as well. 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 a value representing this function evaluated at a given point. More...

Real	dfunc (Real const x) const override
	Returns a value representing the derivative of this function evaluated at a given point. 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 void	read_data (std::istream &)
	initialize this Func from the given std::istream. 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 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. 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
ObjexxFCL::FArray1D< core::Real >	data_

Real	xmin_

Real	xbin_

Size	num_bins_

Detailed Description

Function that allows return of arbitrary FArrays – this time circularized.

Constructor & Destructor Documentation

core::scoring::func::CircularGeneral1D_Func::CircularGeneral1D_Func	(	ObjexxFCL::FArray1D< core::Real > const &	data,
		core::Real const &	xmin,
		core::Real const &	xbin
	)

core::scoring::func::CircularGeneral1D_Func::CircularGeneral1D_Func ( std::string const & filename )

References data_, num_bins_, protocols::hybridization::val, xbin_, and xmin_.

Member Function Documentation

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

inlineoverridevirtual

This method must return a deep copy of this Func, meaning if this Func holds pointers to other Func objects, that it must clone those Func objects as well.

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

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

overridevirtual

Returns a value representing the derivative of this function evaluated at a given point.

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

References data_, num_bins_, xbin_, and xmin_.

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

overridevirtual

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

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

References data_, num_bins_, xbin_, and xmin_.

bool core::scoring::func::CircularGeneral1D_Func::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 data_, num_bins_, same_type_as_me(), core::scoring::func::Func::same_type_as_me(), xbin_, and xmin_.

bool core::scoring::func::CircularGeneral1D_Func::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==().