protocols::jd3::dag_node_managers::NodeManagerStorageMatrix Class Reference

#include <NodeManagerStorageMatrix.hh>

Public Member Functions
	NodeManagerStorageMatrix (utility::vector1< core::Size > n_results_to_keep_for_partition, bool return_results_depth_first=false)
virtual	~NodeManagerStorageMatrix ()
ResultElements	insert (core::Size partition, ResultElements const &new_guy)
ResultElements const &	get_nth_element (core::Size n)
ResultElements const &	get_specific_element (core::Size partition, core::Size index_within_partition)
utility::vector1< ResultElements >	linear_vector_of_results ()
	Freezes the dynamic arrays and appends them onto each other (using the depth-first pattern) More...
void	set_return_results_depth_first (bool setting)
	Consider example at the top of this file to learn more about this option. More...
void	return_results_depth_first ()
void	return_results_breadth_first ()
void	set_max_num_results_with_same_token_per_partition (core::Size setting)
	Perhaps you have a diversity requirement and do not want too many results with the same token (token can represent anything you want - as long as it can be stored as a uint64_t), this setting is for you. More...
core::Size	num_partitions () const
void	clear ()

Private Attributes
utility::vector1< core::Size >	n_results_to_keep_for_partition_
utility::vector1< core::Size >	n_results_accessed_for_partition_
utility::vector1 < utility::vector1 < ResultElements > >	results_for_partition_
bool	return_results_depth_first_
core::Size	max_num_results_with_same_token_per_partition_

Constructor & Destructor Documentation

protocols::jd3::dag_node_managers::NodeManagerStorageMatrix::NodeManagerStorageMatrix	(	utility::vector1< core::Size >	n_results_to_keep_for_partition,
		bool	return_results_depth_first = false
	)

References n_results_to_keep_for_partition_, and results_for_partition_.

protocols::jd3::dag_node_managers::NodeManagerStorageMatrix::~NodeManagerStorageMatrix ( )

virtual

Member Function Documentation

void protocols::jd3::dag_node_managers::NodeManagerStorageMatrix::clear ( )

inline

References results_for_partition_.

Referenced by protocols::jd3::dag_node_managers::NodeManager::clear().

ResultElements const & protocols::jd3::dag_node_managers::NodeManagerStorageMatrix::get_nth_element

(

core::Size

n

)

References n_results_accessed_for_partition_, n_results_to_keep_for_partition_, results_for_partition_, and return_results_depth_first_.

Referenced by protocols::jd3::dag_node_managers::NodeManager::get_nth_job_result_id().

ResultElements const & protocols::jd3::dag_node_managers::NodeManagerStorageMatrix::get_specific_element	(	core::Size	partition,
		core::Size	index_within_partition
	)

References n_results_accessed_for_partition_, and results_for_partition_.

ResultElements protocols::jd3::dag_node_managers::NodeManagerStorageMatrix::insert	(	core::Size	partition,
		ResultElements const &	new_guy
	)

References protocols::jd3::dag_node_managers::get_index_of_last_element_with_token(), protocols::jd3::dag_node_managers::ResultElements::global_job_id, protocols::jd3::dag_node_managers::ResultElements::local_result_id, max_num_results_with_same_token_per_partition_, n_results_accessed_for_partition_, n_results_to_keep_for_partition_, results_for_partition_, protocols::jd3::dag_node_managers::ResultElements::score, and protocols::jd3::dag_node_managers::ResultElements::token.

Referenced by protocols::jd3::dag_node_managers::NodeManager::register_result().

utility::vector1< ResultElements > protocols::jd3::dag_node_managers::NodeManagerStorageMatrix::linear_vector_of_results

(

)

Freezes the dynamic arrays and appends them onto each other (using the depth-first pattern)

References n_results_accessed_for_partition_, n_results_to_keep_for_partition_, and results_for_partition_.

Referenced by protocols::jd3::dag_node_managers::NodeManager::results_to_keep().

core::Size protocols::jd3::dag_node_managers::NodeManagerStorageMatrix::num_partitions ( ) const

inline

References n_results_accessed_for_partition_, n_results_to_keep_for_partition_, and results_for_partition_.

void protocols::jd3::dag_node_managers::NodeManagerStorageMatrix::return_results_breadth_first ( )

inline

References return_results_depth_first_.

void protocols::jd3::dag_node_managers::NodeManagerStorageMatrix::return_results_depth_first ( )

inline

References return_results_depth_first_.

void protocols::jd3::dag_node_managers::NodeManagerStorageMatrix::set_max_num_results_with_same_token_per_partition ( core::Size  setting )

inline

Perhaps you have a diversity requirement and do not want too many results with the same token (token can represent anything you want - as long as it can be stored as a uint64_t), this setting is for you.

References max_num_results_with_same_token_per_partition_.

Referenced by protocols::jd3::dag_node_managers::NodeManager::set_max_num_results_with_same_token_per_partition().

void protocols::jd3::dag_node_managers::NodeManagerStorageMatrix::set_return_results_depth_first ( bool  setting )

inline

Consider example at the top of this file to learn more about this option.

References return_results_depth_first_.

Referenced by protocols::jd3::dag_node_managers::NodeManager::set_return_results_depth_first().

Member Data Documentation

core::Size protocols::jd3::dag_node_managers::NodeManagerStorageMatrix::max_num_results_with_same_token_per_partition_

private

Referenced by insert(), and set_max_num_results_with_same_token_per_partition().

utility::vector1< core::Size > protocols::jd3::dag_node_managers::NodeManagerStorageMatrix::n_results_accessed_for_partition_

private

Referenced by get_nth_element(), get_specific_element(), insert(), linear_vector_of_results(), and num_partitions().

utility::vector1< core::Size > protocols::jd3::dag_node_managers::NodeManagerStorageMatrix::n_results_to_keep_for_partition_

private

Referenced by get_nth_element(), insert(), linear_vector_of_results(), NodeManagerStorageMatrix(), and num_partitions().

utility::vector1< utility::vector1< ResultElements > > protocols::jd3::dag_node_managers::NodeManagerStorageMatrix::results_for_partition_

private

Referenced by clear(), get_nth_element(), get_specific_element(), insert(), linear_vector_of_results(), NodeManagerStorageMatrix(), and num_partitions().

bool protocols::jd3::dag_node_managers::NodeManagerStorageMatrix::return_results_depth_first_

private

Referenced by get_nth_element(), return_results_breadth_first(), return_results_depth_first(), and set_return_results_depth_first().

---

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

• src/protocols/jd3/dag_node_managers/NodeManagerStorageMatrix.hh
• src/protocols/jd3/dag_node_managers/NodeManagerStorageMatrix.cc