Rosetta 3.4
Public Types | Public Member Functions
core::scoring::constraints::OffsetPeriodicBoundFunc Class Reference

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

#include <BoundConstraint.hh>

Inheritance diagram for core::scoring::constraints::OffsetPeriodicBoundFunc:
Inheritance graph
[legend]
Collaboration diagram for core::scoring::constraints::OffsetPeriodicBoundFunc:
Collaboration graph
[legend]

List of all members.

Public Types

typedef BoundFunc parent
typedef BoundFunc parent

Public Member Functions

 OffsetPeriodicBoundFunc (Real const lb, Real const ub, Real sd, std::string type, Real const periodicity_in, Real const offset_in)
FuncOP clone () const
void read_data (std::istream &)
 initialize this Func from the given std::istream.
Real func (Real const x) const
 Returns a value representing this function evaluated at a given point.
Real dfunc (Real const x) const
 Returns a value representing the derivative of this function evaluated at a given point.
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.
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.
 OffsetPeriodicBoundFunc (Real const lb, Real const ub, Real sd, std::string type, Real const periodicity_in, Real const offset_in)
FuncOP clone () const
void read_data (std::istream &)
 initialize this Func from the given std::istream.
Real func (Real const x) const
 Returns a value representing this function evaluated at a given point.
Real dfunc (Real const x) const
 Returns a value representing the derivative of this function evaluated at a given point.
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.
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.

Detailed Description

a variant of the bound func that is periodic


Member Typedef Documentation


Constructor & Destructor Documentation

core::scoring::constraints::OffsetPeriodicBoundFunc::OffsetPeriodicBoundFunc ( Real const  lb,
Real const  ub,
Real  sd,
std::string  type,
Real const  periodicity_in,
Real const  offset_in 
) [inline]

Referenced by clone().

core::scoring::constraints::OffsetPeriodicBoundFunc::OffsetPeriodicBoundFunc ( Real const  lb,
Real const  ub,
Real  sd,
std::string  type,
Real const  periodicity_in,
Real const  offset_in 
) [inline]

Member Function Documentation

FuncOP core::scoring::constraints::OffsetPeriodicBoundFunc::clone ( ) const [inline, virtual]
FuncOP core::scoring::constraints::OffsetPeriodicBoundFunc::clone ( ) const [inline, virtual]
Real core::scoring::constraints::OffsetPeriodicBoundFunc::dfunc ( Real const  const) const [inline, virtual]

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

Real core::scoring::constraints::OffsetPeriodicBoundFunc::dfunc ( Real const  const) const [inline, virtual]

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

Real core::scoring::constraints::OffsetPeriodicBoundFunc::func ( Real const  const) const [inline, virtual]

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

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

References core::scoring::constraints::BoundFunc::func().

Real core::scoring::constraints::OffsetPeriodicBoundFunc::func ( Real const  const) const [inline, virtual]

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

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

References core::scoring::constraints::BoundFunc::func().

void core::scoring::constraints::OffsetPeriodicBoundFunc::read_data ( std::istream &  ) [virtual]

initialize this Func from the given std::istream.

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

References core::scoring::constraints::BoundFunc::read_data().

void core::scoring::constraints::OffsetPeriodicBoundFunc::read_data ( std::istream &  ) [virtual]

initialize this Func from the given std::istream.

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

void core::scoring::constraints::OffsetPeriodicBoundFunc::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::BoundFunc.

void core::scoring::constraints::OffsetPeriodicBoundFunc::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::BoundFunc.

References core::scoring::constraints::BoundFunc::show_definition().

virtual Size core::scoring::constraints::OffsetPeriodicBoundFunc::show_violations ( std::ostream &  out,
Real  r,
Size  verbose_level,
Real  threshold = 1 
) const [inline, virtual]

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

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

References core::scoring::constraints::BoundFunc::show_violations().

virtual Size core::scoring::constraints::OffsetPeriodicBoundFunc::show_violations ( std::ostream &  out,
Real  r,
Size  verbose_level,
Real  threshold = 1 
) const [inline, virtual]

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

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

References core::scoring::constraints::BoundFunc::show_violations().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines