Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Private Attributes | List of all members
protocols::multistate_design::MultiStateFitnessFunction Class Referenceabstract

#include <MultiStateFitnessFunction.hh>

Inheritance diagram for protocols::multistate_design::MultiStateFitnessFunction:
Inheritance graph
[legend]

Public Types

typedef
utility::pointer::shared_ptr
< MultiStateFitnessFunction
OP
 
- Public Types inherited from protocols::genetic_algorithm::FitnessFunction
typedef
utility::pointer::shared_ptr
< FitnessFunction
OP
 
typedef
utility::pointer::shared_ptr
< FitnessFunction const > 
COP
 

Public Member Functions

 MultiStateFitnessFunction ()
 
 ~MultiStateFitnessFunction () override
 
virtual void add_state (SingleStateOP state)
 
virtual void add_state (core::pose::Pose const &pose, bool is_positive)
 
core::Real evaluate (protocols::genetic_algorithm::Entity &entity) override
 
virtual core::Real evaluate (protocols::genetic_algorithm::Entity &entity, core::Size single_state_num)=0
 
virtual core::Real evaluate_positive_states (protocols::genetic_algorithm::Entity &entity)
 
virtual void set_aggregate_function (MultiStateAggregateFunction::COP aggregate_function)
 
virtual
MultiStateAggregateFunction::COP 
aggregate_function () const
 
virtual void set_scorefxn (core::scoring::ScoreFunctionCOP sf)
 
virtual
core::scoring::ScoreFunctionCOP 
scorefxn () const
 
virtual SingleStateCOPs const_states (bool positive_only=false) const
 true const (read only) access to states More...
 
virtual SingleStateCOPs positive_states () const
 
virtual core::Size num_states () const
 
virtual core::Size num_states (bool pos_neg) const
 
virtual core::Size num_positive_states () const
 
virtual core::Size num_negative_states () const
 
virtual void add_metric_value_getter (std::string const &name, protocols::pose_metric_calculators::MetricValueGetter const &metric_value_getter)
 
- Public Member Functions inherited from protocols::genetic_algorithm::FitnessFunction
 ~FitnessFunction () override=default
 

Protected Types

typedef std::map< std::string,
protocols::pose_metric_calculators::MetricValueGetter
MetricValueGetterMap
 

Protected Member Functions

virtual SingleStateOPsstates ()
 
MetricValueGetterMap const & metric_value_getters () const
 

Private Attributes

SingleStateOPs states_
 
MultiStateAggregateFunction::COP aggregate_function_
 
core::scoring::ScoreFunctionCOP scorefxn_
 
utility::vector1
< core::pose::PoseOP
best_entity_positive_states_
 
core::Real best_fitness_
 
MetricValueGetterMap metric_value_getters_
 

Member Typedef Documentation

Constructor & Destructor Documentation

protocols::multistate_design::MultiStateFitnessFunction::MultiStateFitnessFunction ( )
protocols::multistate_design::MultiStateFitnessFunction::~MultiStateFitnessFunction ( )
overridedefault

Member Function Documentation

void protocols::multistate_design::MultiStateFitnessFunction::add_metric_value_getter ( std::string const &  name,
protocols::pose_metric_calculators::MetricValueGetter const &  metric_value_getter 
)
virtual

References metric_value_getters_.

void protocols::multistate_design::MultiStateFitnessFunction::add_state ( SingleStateOP  state)
virtual

References best_entity_positive_states_, and states_.

Referenced by add_state().

void protocols::multistate_design::MultiStateFitnessFunction::add_state ( core::pose::Pose const &  pose,
bool  is_positive 
)
virtual

References add_state().

MultiStateAggregateFunction::COP protocols::multistate_design::MultiStateFitnessFunction::aggregate_function ( ) const
virtual

References aggregate_function_.

Referenced by set_aggregate_function().

SingleStateCOPs protocols::multistate_design::MultiStateFitnessFunction::const_states ( bool  positive_only = false) const
virtual
core::Real protocols::multistate_design::MultiStateFitnessFunction::evaluate ( protocols::genetic_algorithm::Entity entity)
overridevirtual
virtual core::Real protocols::multistate_design::MultiStateFitnessFunction::evaluate ( protocols::genetic_algorithm::Entity entity,
core::Size  single_state_num 
)
pure virtual
core::Real protocols::multistate_design::MultiStateFitnessFunction::evaluate_positive_states ( protocols::genetic_algorithm::Entity entity)
virtual

References evaluate(), and states_.

std::map< std::string, protocols::pose_metric_calculators::MetricValueGetter > const & protocols::multistate_design::MultiStateFitnessFunction::metric_value_getters ( ) const
protected
virtual core::Size protocols::multistate_design::MultiStateFitnessFunction::num_negative_states ( ) const
inlinevirtual

References num_states().

virtual core::Size protocols::multistate_design::MultiStateFitnessFunction::num_positive_states ( ) const
inlinevirtual

References num_states().

virtual core::Size protocols::multistate_design::MultiStateFitnessFunction::num_states ( ) const
inlinevirtual

References states_.

Referenced by num_negative_states(), and num_positive_states().

core::Size protocols::multistate_design::MultiStateFitnessFunction::num_states ( bool  pos_neg) const
virtual

References states_.

SingleStateCOPs protocols::multistate_design::MultiStateFitnessFunction::positive_states ( ) const
virtual

References const_states().

core::scoring::ScoreFunctionCOP protocols::multistate_design::MultiStateFitnessFunction::scorefxn ( ) const
virtual
void protocols::multistate_design::MultiStateFitnessFunction::set_aggregate_function ( MultiStateAggregateFunction::COP  aggregate_function)
virtual
void protocols::multistate_design::MultiStateFitnessFunction::set_scorefxn ( core::scoring::ScoreFunctionCOP  sf)
virtual

References scorefxn_.

SingleStateOPs & protocols::multistate_design::MultiStateFitnessFunction::states ( )
protectedvirtual

Member Data Documentation

MultiStateAggregateFunction::COP protocols::multistate_design::MultiStateFitnessFunction::aggregate_function_
private
utility::vector1< core::pose::PoseOP > protocols::multistate_design::MultiStateFitnessFunction::best_entity_positive_states_
private

Referenced by add_state(), and evaluate().

core::Real protocols::multistate_design::MultiStateFitnessFunction::best_fitness_
private

Referenced by evaluate().

MetricValueGetterMap protocols::multistate_design::MultiStateFitnessFunction::metric_value_getters_
private
core::scoring::ScoreFunctionCOP protocols::multistate_design::MultiStateFitnessFunction::scorefxn_
private

Referenced by scorefxn(), and set_scorefxn().

SingleStateOPs protocols::multistate_design::MultiStateFitnessFunction::states_
private

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