Public Member Functions | Protected Member Functions | Private Attributes | List of all members
core::optimization::CartesianMultifunc Class Reference

Atom tree multifunction class. More...

#include <CartesianMultifunc.hh>

Inheritance diagram for core::optimization::CartesianMultifunc:
Inheritance graph

Public Member Functions

 CartesianMultifunc (pose::Pose &pose_in, CartesianMinimizerMap &min_map_in, scoring::ScoreFunction const &scorefxn_in, bool const deriv_check_in=false, bool const deriv_check_verbose_in=false)
 ~CartesianMultifunc () override
 Destructor. More...
Real operator() (Multivec const &vars) const override
void dfunc (Multivec const &vars, Multivec &dE_dvars) const override
void set_deriv_check_result (NumericalDerivCheckResultOP deriv_check_result)
void dump (Multivec const &vars, Multivec const &vars2) const override
 Error state reached – derivative does not match gradient. More...
- Public Member Functions inherited from core::optimization::Multifunc
 ~Multifunc () override=default
 Destructor. More...
virtual bool abort_min (Multivec const &) const
 Christophe added the following to allow premature end of minimization If you want to abort the minimizer under specific circonstances overload this function and return true if you want to stop, false if you want to continue. FOR THE MOMENT, ONLY IN DFPMIN! More...

Protected Member Functions

pose::Posepose () const
 non-const since pose_ is modified by calls to operator() More...
CartesianMinimizerMap const & min_map () const
scoring::ScoreFunction const & score_function () const
- Protected Member Functions inherited from core::optimization::Multifunc
 Multifunc ()
 Default constructor. More...
 Multifunc (Multifunc const &)
 Copy constructor. More...
Multifuncoperator= (Multifunc const &)
 Copy assignment. More...

Private Attributes

 non-const since pose_ is modified by calls to operator() More...
 non-const since min_map_ is modified by calls to dfunc() More...
scoring::ScoreFunction const & score_function_
bool deriv_check_
bool deriv_check_verbose_
NumericalDerivCheckResultOP deriv_check_result_

Additional Inherited Members

- Public Types inherited from core::optimization::Multifunc
typedef utility::VirtualBase parent

Detailed Description

Atom tree multifunction class.

Constructor & Destructor Documentation

◆ CartesianMultifunc()

core::optimization::CartesianMultifunc::CartesianMultifunc ( pose::Pose pose_in,
CartesianMinimizerMap min_map_in,
scoring::ScoreFunction const &  scorefxn_in,
bool const  deriv_check_in = false,
bool const  deriv_check_verbose_in = false 

◆ ~CartesianMultifunc()

core::optimization::CartesianMultifunc::~CartesianMultifunc ( )


Member Function Documentation

◆ dfunc()

void core::optimization::CartesianMultifunc::dfunc ( Multivec const &  vars,
Multivec dE_dvars 
) const

◆ dump()

void core::optimization::CartesianMultifunc::dump ( Multivec const &  vars,
Multivec const &  vars2 
) const

◆ min_map()

CartesianMinimizerMap const & core::optimization::CartesianMultifunc::min_map ( ) const

References min_map_.

◆ operator()()

Real core::optimization::CartesianMultifunc::operator() ( Multivec const &  vars) const

◆ pose()

core::pose::Pose & core::optimization::CartesianMultifunc::pose ( ) const

non-const since pose_ is modified by calls to operator()

References pose_.

◆ score_function()

core::scoring::ScoreFunction const & core::optimization::CartesianMultifunc::score_function ( ) const

References score_function_.

◆ set_deriv_check_result()

void core::optimization::CartesianMultifunc::set_deriv_check_result ( NumericalDerivCheckResultOP  deriv_check_result)

Member Data Documentation

◆ deriv_check_

bool core::optimization::CartesianMultifunc::deriv_check_

Referenced by dfunc(), and dump().

◆ deriv_check_result_

NumericalDerivCheckResultOP core::optimization::CartesianMultifunc::deriv_check_result_

Referenced by dfunc(), and set_deriv_check_result().

◆ deriv_check_verbose_

bool core::optimization::CartesianMultifunc::deriv_check_verbose_

Referenced by dfunc(), and dump().

◆ min_map_

CartesianMinimizerMap& core::optimization::CartesianMultifunc::min_map_

non-const since min_map_ is modified by calls to dfunc()

Referenced by dfunc(), dump(), min_map(), and operator()().

◆ pose_

pose::Pose& core::optimization::CartesianMultifunc::pose_

non-const since pose_ is modified by calls to operator()

Referenced by dfunc(), dump(), operator()(), and pose().

◆ score_function_

scoring::ScoreFunction const& core::optimization::CartesianMultifunc::score_function_

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