protocols::multistate_design::MultiStateFitnessFunction Class Reference

#include <MultiStateFitnessFunction.hh>

Inheritance diagram for protocols::multistate_design::MultiStateFitnessFunction:

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 SingleStateOPs &	states ()
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

MetricValueGetterMap

typedef std::map<std::string, protocols::pose_metric_calculators::MetricValueGetter> protocols::multistate_design::MultiStateFitnessFunction::MetricValueGetterMap

protected

OP

typedef utility::pointer::shared_ptr< MultiStateFitnessFunction > protocols::multistate_design::MultiStateFitnessFunction::OP

Constructor & Destructor Documentation

MultiStateFitnessFunction()

protocols::multistate_design::MultiStateFitnessFunction::MultiStateFitnessFunction

(

)

~MultiStateFitnessFunction()

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

overridedefault

Member Function Documentation

add_metric_value_getter()

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_.

add_state() [1/2]

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

virtual

References add_state().

add_state() [2/2]

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

virtual

References best_entity_positive_states_, and states_.

Referenced by add_state().

aggregate_function()

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

virtual

References aggregate_function_.

Referenced by set_aggregate_function().

const_states()

SingleStateCOPs protocols::multistate_design::MultiStateFitnessFunction::const_states ( bool  positive_only = false ) const

virtual

true const (read only) access to states

References states_.

Referenced by protocols::multistate_design::MultiStateAggregateFunction::evaluate(), protocols::multistate_design::PartitionAggregateFunction::evaluate(), and positive_states().

evaluate() [1/2]

core::Real protocols::multistate_design::MultiStateFitnessFunction::evaluate ( protocols::genetic_algorithm::Entity &  entity )

overridevirtual

Implements protocols::genetic_algorithm::FitnessFunction.

References aggregate_function_, best_entity_positive_states_, best_fitness_, protocols::genetic_algorithm::Entity::set_fitness(), protocols::multistate_design::MultiStateEntity::single_state_entity_data(), states(), and states_.

Referenced by evaluate_positive_states().

evaluate() [2/2]

virtual core::Real protocols::multistate_design::MultiStateFitnessFunction::evaluate ( protocols::genetic_algorithm::Entity &  entity, core::Size  single_state_num  )

pure virtual

Implemented in protocols::multistate_design::MultiStatePacker.

evaluate_positive_states()

core::Real protocols::multistate_design::MultiStateFitnessFunction::evaluate_positive_states ( protocols::genetic_algorithm::Entity &  entity )

virtual

References evaluate(), and states_.

metric_value_getters()

std::map< std::string, protocols::pose_metric_calculators::MetricValueGetter > const & protocols::multistate_design::MultiStateFitnessFunction::metric_value_getters ( ) const

protected

References metric_value_getters_.

Referenced by protocols::multistate_design::MultiStatePacker::evaluate().

num_negative_states()

virtual core::Size protocols::multistate_design::MultiStateFitnessFunction::num_negative_states ( ) const

inlinevirtual

References num_states().

num_positive_states()

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

inlinevirtual

References num_states().

num_states() [1/2]

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

inlinevirtual

References states_.

Referenced by num_negative_states(), and num_positive_states().

num_states() [2/2]

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

virtual

References states_.

positive_states()

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

virtual

References const_states().

scorefxn()

core::scoring::ScoreFunctionCOP protocols::multistate_design::MultiStateFitnessFunction::scorefxn ( ) const

virtual

References scorefxn_.

Referenced by protocols::multistate_design::MultiStatePacker::evaluate(), and protocols::multistate_design::MultiStatePacker::single_state_design().

set_aggregate_function()

void protocols::multistate_design::MultiStateFitnessFunction::set_aggregate_function ( MultiStateAggregateFunction::COP  aggregate_function )

virtual

References aggregate_function(), and aggregate_function_.

set_scorefxn()

void protocols::multistate_design::MultiStateFitnessFunction::set_scorefxn ( core::scoring::ScoreFunctionCOP  sf )

virtual

References scorefxn_.

states()

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

protectedvirtual

References states_.

Referenced by evaluate(), protocols::multistate_design::MultiStatePacker::evaluate(), and protocols::multistate_design::MultiStatePacker::single_state_design().

Member Data Documentation

aggregate_function_

MultiStateAggregateFunction::COP protocols::multistate_design::MultiStateFitnessFunction::aggregate_function_

private

Referenced by aggregate_function(), evaluate(), and set_aggregate_function().

best_entity_positive_states_

utility::vector1< core::pose::PoseOP > protocols::multistate_design::MultiStateFitnessFunction::best_entity_positive_states_

private

Referenced by add_state(), and evaluate().

best_fitness_

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

private

Referenced by evaluate().

metric_value_getters_

MetricValueGetterMap protocols::multistate_design::MultiStateFitnessFunction::metric_value_getters_

private

Referenced by add_metric_value_getter(), and metric_value_getters().

scorefxn_

core::scoring::ScoreFunctionCOP protocols::multistate_design::MultiStateFitnessFunction::scorefxn_

private

Referenced by scorefxn(), and set_scorefxn().

states_

SingleStateOPs protocols::multistate_design::MultiStateFitnessFunction::states_

private

Referenced by add_state(), const_states(), evaluate(), evaluate_positive_states(), num_states(), and states().

---

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

• src/protocols/multistate_design/MultiStateFitnessFunction.hh
• src/protocols/multistate_design/MultiStateFitnessFunction.cc