a variant of the bound func that is periodic More...

#include <BoundConstraint.hh>

Inheritance diagram for core::scoring::constraints::PeriodicBoundFunc:

Public Types
typedef BoundFunc	parent

Public Member Functions
	PeriodicBoundFunc (Real const lb, Real const ub, Real sd, std::string type, Real const periodicity_in)

func::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 &rhs) const override

bool	same_type_as_me (Func const &rhs) const override

void	read_data (std::istream &) override
	initialize this Func from the given std::istream. 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...

void	show_definition (std::ostream &out) const override
	shows the definition of this function, usually the string type of function and the parameters passed in to the constructor. More...

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

Public Member Functions inherited from core::scoring::constraints::BoundFunc
	BoundFunc (Real const lb, Real const ub, Real sd, std::string const &type)

	BoundFunc (Real const lb, Real const ub, Real sd, Real rswitch, std::string const &type)

bool	operator== (Func const &rhs) const override

bool	same_type_as_me (Func const &other) const override

Real	lb () const

Real	ub () const

Real	sd () const

Real	rswitch () const

std::string	type () const

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

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

bool	operator!= (Func const &other) const
	inequality operator – simply the negation of the (virtual) equality operator More...

virtual bool	same_type_as_me (Func const &other) const =0
	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...

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...

Private Attributes
Real	periodicity_

Detailed Description

a variant of the bound func that is periodic

Member Typedef Documentation

typedef BoundFunc core::scoring::constraints::PeriodicBoundFunc::parent

Constructor & Destructor Documentation

core::scoring::constraints::PeriodicBoundFunc::PeriodicBoundFunc	(	Real const	lb,
		Real const	ub,
		Real	sd,
		std::string	type,
		Real const	periodicity_in
	)

Member Function Documentation

func::FuncOP core::scoring::constraints::PeriodicBoundFunc::clone ( ) const

overridevirtual

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.

Reimplemented from core::scoring::constraints::BoundFunc.

Real core::scoring::constraints::PeriodicBoundFunc::dfunc ( Real const const ) const

overridevirtual

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

Reimplemented from core::scoring::constraints::BoundFunc.

References core::scoring::constraints::BoundFunc::dfunc(), and periodicity_.

Real core::scoring::constraints::PeriodicBoundFunc::func ( Real const const ) const

overridevirtual

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

Reimplemented from core::scoring::constraints::BoundFunc.

References core::scoring::constraints::BoundFunc::func(), and periodicity_.

bool core::scoring::constraints::PeriodicBoundFunc::operator== ( Func const & rhs ) const

override

References core::scoring::constraints::BoundFunc::operator==(), periodicity_, and same_type_as_me().

void core::scoring::constraints::PeriodicBoundFunc::read_data ( std::istream & )

overridevirtual

initialize this Func from the given std::istream.

Reimplemented from core::scoring::constraints::BoundFunc.

References periodicity_, and core::scoring::constraints::BoundFunc::read_data().

bool core::scoring::constraints::PeriodicBoundFunc::same_type_as_me ( Func const & rhs ) const

override

Referenced by operator==().

void core::scoring::constraints::PeriodicBoundFunc::show_definition ( std::ostream & out ) const

overridevirtual

shows the definition of this function, usually the string type of function and the parameters passed in to the constructor.

Reimplemented from core::scoring::constraints::BoundFunc.

References periodicity_, and core::scoring::constraints::BoundFunc::show_definition().

Size core::scoring::constraints::PeriodicBoundFunc::show_violations	(	std::ostream &	out,
		Real	r,
		Size	verbose_level,
		Real	threshold = `1`
	)		const

overridevirtual

show some sort of stringified representation of the violations for this constraint.

Reimplemented from core::scoring::constraints::BoundFunc.

References periodicity_, and core::scoring::constraints::BoundFunc::show_violations().

Member Data Documentation

Real core::scoring::constraints::PeriodicBoundFunc::periodicity_

private

Referenced by dfunc(), func(), operator==(), read_data(), show_definition(), and show_violations().

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

src/core/scoring/constraints/BoundConstraint.hh
src/core/scoring/constraints/BoundConstraint.cc

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation