Rosetta 3.5
 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]
Collaboration diagram for protocols::frag_picker::scores::FragmentScoreMap:
Collaboration graph
[legend]

Public Member Functions

 FragmentScoreMap (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...
 
Size size () const
 
Real at (Size score_index) const
 
utility::vector1< Real > & get_score_components () const
 returns the vector of score components More...
 
void set_score_component (Real score_value, Size component_id)
 sets a new score value for a given component More...
 
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...
 
Real get_quota_score ()
 
void set_quota_score (Real quota_score)
 

Private Attributes

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

Friends

class FragmentScoreManager
 

Detailed Description

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

Detailed: 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 ( Size  n_componens)
inline

creates a new map for a given number of components

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

Member Function Documentation

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

creates a new deep copy of this map

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

returns the total score that has been evaluated recently

Detailed: 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
Real protocols::frag_picker::scores::FragmentScoreMap::get_quota_score ( )
inline
utility::vector1<Real>& protocols::frag_picker::scores::FragmentScoreMap::get_score_components ( ) const
inline

returns the vector of score components

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

sets a new score value for a given component

Size protocols::frag_picker::scores::FragmentScoreMap::size ( ) const
inline
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.

Friends And Related Function Documentation

friend class FragmentScoreManager
friend

Member Data Documentation

Real protocols::frag_picker::scores::FragmentScoreMap::recent_quota_score_
private
Real protocols::frag_picker::scores::FragmentScoreMap::recent_total_
private
utility::vector1<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: