Rosetta 3.5: core::scoring::constraints::BoundFunc Class Reference

#include <BoundConstraint.hh>

Inheritance diagram for core::scoring::constraints::BoundFunc:

Inheritance graph

Collaboration diagram for core::scoring::constraints::BoundFunc:

Collaboration graph

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

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

virtual FuncOP	clone () const

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

virtual Real	func (Real const x) const
	Returns a value representing this function evaluated at a given point. More...

virtual Real	dfunc (Real const x) const
	Returns a value representing the derivative of this function evaluated at a given point. 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 x, Size verbose_level, Real threshold=1) const
	show some sort of stringified representation of the violations for this constraint. More...

Real	lb () const

Real	ub () const

Real	sd () const

Real	rswitch () const

std::string	type () const

Public Member Functions inherited from core::scoring::constraints::Func
virtual	~Func ()
	Automatically generated virtual destructor for class deriving directly from ReferenceCount. 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	lb_

Real	ub_

Real	sd_

Real	rswitch_

std::string	type_

Detailed Description

Definition at line 42 of file BoundConstraint.hh.

Constructor & Destructor Documentation

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

inline

Definition at line 44 of file BoundConstraint.hh.

Referenced by clone().

core::scoring::constraints::BoundFunc::BoundFunc	(	Real const	lb,
		Real const	ub,
		Real	sd,
		Real	rswitch,
		std::string	type
	)

inline

Definition at line 45 of file BoundConstraint.hh.

Member Function Documentation

virtual FuncOP core::scoring::constraints::BoundFunc::clone ( ) const

inlinevirtual

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

Reimplemented in core::scoring::constraints::OffsetPeriodicBoundFunc, and core::scoring::constraints::PeriodicBoundFunc.

Definition at line 49 of file BoundConstraint.hh.

References BoundFunc().

Referenced by protocols::abinitio::AlternativePairings::build_constraints().

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

virtual

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

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

Reimplemented in core::scoring::constraints::OffsetPeriodicBoundFunc, and core::scoring::constraints::PeriodicBoundFunc.

Definition at line 65 of file BoundConstraint.cc.

References lb_, rswitch_, sd_, and ub_.

Referenced by core::scoring::constraints::PeriodicBoundFunc::dfunc(), and core::scoring::constraints::OffsetPeriodicBoundFunc::dfunc().

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

virtual

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

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

Reimplemented in core::scoring::constraints::OffsetPeriodicBoundFunc, and core::scoring::constraints::PeriodicBoundFunc.

Definition at line 41 of file BoundConstraint.cc.

References lb_, rswitch_, sd_, and ub_.

Referenced by core::scoring::constraints::PeriodicBoundFunc::func(), core::scoring::constraints::OffsetPeriodicBoundFunc::func(), and show_violations().

Real core::scoring::constraints::BoundFunc::lb ( ) const

inline

Definition at line 68 of file BoundConstraint.hh.

References lb_.

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

virtual

initialize this Func from the given std::istream.

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

Reimplemented in core::scoring::constraints::OffsetPeriodicBoundFunc, and core::scoring::constraints::PeriodicBoundFunc.

Definition at line 123 of file BoundConstraint.cc.

References lb_, rswitch_, sd_, type_, and ub_.

Real core::scoring::constraints::BoundFunc::rswitch ( ) const

inline

Definition at line 71 of file BoundConstraint.hh.

References rswitch_.

Real core::scoring::constraints::BoundFunc::sd ( ) const

inline

Definition at line 70 of file BoundConstraint.hh.

References sd_.

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

virtual

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

Reimplemented in core::scoring::constraints::OffsetPeriodicBoundFunc, and core::scoring::constraints::PeriodicBoundFunc.

Definition at line 113 of file BoundConstraint.cc.

References lb_, rswitch_, sd_, type_, and ub_.

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

virtual

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

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

Reimplemented in core::scoring::constraints::OffsetPeriodicBoundFunc, and core::scoring::constraints::PeriodicBoundFunc.

Definition at line 84 of file BoundConstraint.cc.

References func(), lb_, sd_, type_, and ub_.

Referenced by core::scoring::constraints::PeriodicBoundFunc::show_violations(), and core::scoring::constraints::OffsetPeriodicBoundFunc::show_violations().

std::string core::scoring::constraints::BoundFunc::type ( ) const

inline

Definition at line 72 of file BoundConstraint.hh.

References type_.

Real core::scoring::constraints::BoundFunc::ub ( ) const

inline

Definition at line 69 of file BoundConstraint.hh.

References ub_.

Member Data Documentation

Real core::scoring::constraints::BoundFunc::lb_

private

Definition at line 75 of file BoundConstraint.hh.

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

Real core::scoring::constraints::BoundFunc::rswitch_

private

Definition at line 78 of file BoundConstraint.hh.

Referenced by dfunc(), func(), read_data(), rswitch(), and show_definition().

Real core::scoring::constraints::BoundFunc::sd_

private

Definition at line 77 of file BoundConstraint.hh.

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

std::string core::scoring::constraints::BoundFunc::type_

private

Definition at line 79 of file BoundConstraint.hh.

Referenced by read_data(), show_definition(), show_violations(), and type().

Real core::scoring::constraints::BoundFunc::ub_

private

Definition at line 76 of file BoundConstraint.hh.

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

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

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