core::scoring::constraints::DOF_Constraint Class Reference

This isn't quite a standard constraint since it acts on DOF's directly rather than on XYZ coordinates. More...

#include <DOF_Constraint.hh>

Inheritance diagram for core::scoring::constraints::DOF_Constraint:

Public Member Functions
	DOF_Constraint (id::DOF_ID const &id, core::scoring::func::FuncOP func, ScoreType t=dof_constraint)
	~DOF_Constraint () override
id::DOF_ID const &	dof_id () const
	Returns the ScoreType. More...
ScoreType const &	score_type () const
	Returns the ScoreType. More...
Real	func (Real const val) const
	Returns the func::Function. More...
Real	dfunc (Real const val) const
	Returns the func::Function Derivative. More...
virtual void	show (std::ostream &out) const

Private Attributes
id::DOF_ID const	dof_id_
func::FuncOP	func_
ScoreType const	score_type_

Detailed Description

This isn't quite a standard constraint since it acts on DOF's directly rather than on XYZ coordinates.

All DOF_Constraints are expected to be immutable once created, meaning their internal data (state) should not change over their lifetime. This allows DOF_Constraints to be shared between copies of Poses (e.g. in Monte Carlo), and is important for both speed (with thousands of contraints) and correctness.

DOF_Constraints are currently unsupported – they are never evaluated if you put them into a Pose.

Constructor & Destructor Documentation

core::scoring::constraints::DOF_Constraint::DOF_Constraint	(	id::DOF_ID const &	id,
		core::scoring::func::FuncOP	func,
		ScoreType	t = dof_constraint
	)

core::scoring::constraints::DOF_Constraint::~DOF_Constraint ( )

overridedefault

Member Function Documentation

Real core::scoring::constraints::DOF_Constraint::dfunc

(

Real const

val

)

const

Returns the func::Function Derivative.

References func_.

id::DOF_ID const & core::scoring::constraints::DOF_Constraint::dof_id

(

)

const

Returns the ScoreType.

References dof_id_.

Real core::scoring::constraints::DOF_Constraint::func

(

Real const

val

)

const

Returns the func::Function.

References func_.

ScoreType const & core::scoring::constraints::DOF_Constraint::score_type

(

)

const

Returns the ScoreType.

References score_type_.

void core::scoring::constraints::DOF_Constraint::show ( std::ostream &  out ) const

virtual

Member Data Documentation

id::DOF_ID const core::scoring::constraints::DOF_Constraint::dof_id_

private

Referenced by dof_id().

func::FuncOP core::scoring::constraints::DOF_Constraint::func_

private

Referenced by dfunc(), and func().

ScoreType const core::scoring::constraints::DOF_Constraint::score_type_

private

Referenced by score_type().

---

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

• src/core/scoring/constraints/DOF_Constraint.hh
• src/core/scoring/constraints/DOF_Constraint.cc