Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Attributes | Friends | List of all members
protocols::frag_picker::scores::FragmentScoreMap Class Reference

holds all small scores (score components) for a given fragment More...

#include <FragmentScoreMap.hh>

Inheritance diagram for protocols::frag_picker::scores::FragmentScoreMap:
Inheritance graph
[legend]

Public Member Functions

 FragmentScoreMap (core::Size n_componens)
 creates a new map for a given number of components More...
 
FragmentScoreMapOP clone () const
 creates a new deep copy of this map More...
 
core::Size size () const
 
core::Real at (core::Size score_index) const
 
utility::vector1< core::Real > & get_score_components () const
 returns the vector of score components More...
 
void set_score_component (core::Real score_value, core::Size component_id)
 sets a new score value for a given component More...
 
core::Real get_most_recent_total_score ()
 returns the total score that has been evaluated recently More...
 
bool was_modified ()
 If the map has been modified, the total score it holds is not up-to-date and must be recalculated. More...
 
core::Real get_quota_score ()
 
void set_quota_score (core::Real quota_score)
 

Private Attributes

utility::vector1< core::Realsmall_scores_
 
core::Real recent_total_
 
core::Real recent_quota_score_
 
bool was_modified_
 

Friends

class FragmentScoreManager
 

Detailed Description

holds all small scores (score components) for a given fragment

each scoring method puts its own result into the map. The total score is a dot product of the vector from this map and a vector of weights

Constructor & Destructor Documentation

protocols::frag_picker::scores::FragmentScoreMap::FragmentScoreMap ( core::Size  n_componens)
inline

creates a new map for a given number of components

usually the new map should be created by FragmentScoreManager::create_empty_map()

References recent_quota_score_, recent_total_, small_scores_, and was_modified_.

Referenced by clone().

Member Function Documentation

core::Real protocols::frag_picker::scores::FragmentScoreMap::at ( core::Size  score_index) const
inline

References small_scores_.

FragmentScoreMapOP protocols::frag_picker::scores::FragmentScoreMap::clone ( ) const
inline

creates a new deep copy of this map

References FragmentScoreMap(), recent_total_, small_scores_, and was_modified_.

core::Real protocols::frag_picker::scores::FragmentScoreMap::get_most_recent_total_score ( )
inline

returns the total score that has been evaluated recently

the method does not compute anything. You must check if the map has been modified after the last total score calculation. If so, you must recompute the total again

References recent_total_.

core::Real protocols::frag_picker::scores::FragmentScoreMap::get_quota_score ( )
inline

References recent_quota_score_.

utility::vector1<core::Real>& protocols::frag_picker::scores::FragmentScoreMap::get_score_components ( ) const
inline

returns the vector of score components

References small_scores_.

Referenced by protocols::frag_picker::FragmentScoreFilter::compute().

void protocols::frag_picker::scores::FragmentScoreMap::set_quota_score ( core::Real  quota_score)
inline

References recent_quota_score_.

void protocols::frag_picker::scores::FragmentScoreMap::set_score_component ( core::Real  score_value,
core::Size  component_id 
)
inline

sets a new score value for a given component

References small_scores_, and was_modified_.

core::Size protocols::frag_picker::scores::FragmentScoreMap::size ( ) const
inline

References small_scores_.

bool protocols::frag_picker::scores::FragmentScoreMap::was_modified ( )
inline

If the map has been modified, the total score it holds is not up-to-date and must be recalculated.

References was_modified_.

Friends And Related Function Documentation

friend class FragmentScoreManager
friend

Member Data Documentation

core::Real protocols::frag_picker::scores::FragmentScoreMap::recent_quota_score_
private
core::Real protocols::frag_picker::scores::FragmentScoreMap::recent_total_
private
utility::vector1<core::Real> protocols::frag_picker::scores::FragmentScoreMap::small_scores_
private
bool protocols::frag_picker::scores::FragmentScoreMap::was_modified_
private

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