Tags used to tag messeges sent by MPI functions used to decide whether a slave is requesting a new job id or flagging as job as being a bad input. More...

#include <ArchiveBase.hh>

Inheritance diagram for protocols::jd2::archive::AbstractArchiveBase:

[legend]

Collaboration diagram for protocols::jd2::archive::AbstractArchiveBase:

[legend]

Public Member Functions
virtual	~AbstractArchiveBase ()
	Automatically generated virtual destructor for class deriving directly from ReferenceCount. More...

	AbstractArchiveBase (ArchiveManagerAP ptr)

	AbstractArchiveBase ()

virtual bool	finished () const =0
	is archive converged ? More...

virtual void	initialize ()=0

virtual bool	still_interested (jd2::archive::Batch const &) const
	old-batches might be outdated and should not be computed anymore return true for this query if this is the case for old_batch More...

virtual void	generate_batch ()=0
	create a new batch with manager().start_new_batch() and manager().finalize_batch(); More...

virtual void	idle ()=0
	do some computations on archive that can be done while we are waiting More...

virtual void	read_structures (core::io::silent::SilentFileData &returned_decoys, Batch const &batch)=0
	read 'returned_decoys' from 'batch' into archive. More...

virtual void	save_to_file (std::string suffix="")=0
	save archive to file .. you can put 'suffix' at end of dirname to save other snapshots than the 'current' More...

virtual void	save_status (std::ostream &) const =0

virtual bool	restore_from_file ()=0
	restore archive More...

virtual void	init_from_decoy_set (core::io::silent::SilentFileData const &sfd)=0

void	set_name (std::string const &set)
	set name of archive ( used also for save_to_file and restore_from_file ) More...

std::string const &	name () const

ArchiveManager &	manager ()
	access to the ArchiveManager (control of batches) More...

virtual void	set_manager (ArchiveManagerAP manager)

Protected Member Functions
ArchiveManagerAP	manager_ptr ()

Private Attributes
ArchiveManagerAP	manager_

std::string	name_

Detailed Description

Tags used to tag messeges sent by MPI functions used to decide whether a slave is requesting a new job id or flagging as job as being a bad input.

This job distributor is meant for running jobs where the machine you are using has a large number of processors, the number of jobs is much greater than the number of processors, or the runtimes of the individual jobs could vary greatly. It dedicates the head node (whichever processor gets processor rank #0) to handling job requests from the slave nodes (all nonzero ranks). Unlike the MPIWorkPartitionJobDistributor, this JD will not work at all without MPI and the implementations of all but the interface functions have been put inside of ifdef directives. Generally each function has a master and slave version, and the interface functions call one or the other depending on processor rank.

Definition at line 59 of file ArchiveBase.hh.

Constructor & Destructor Documentation

protocols::jd2::archive::AbstractArchiveBase::~AbstractArchiveBase ( )

virtual

Automatically generated virtual destructor for class deriving directly from ReferenceCount.

Auto-generated virtual destructor

Definition at line 87 of file ArchiveBase.cc.

protocols::jd2::archive::AbstractArchiveBase::AbstractArchiveBase ( ArchiveManagerAP ptr)

inline

Definition at line 63 of file ArchiveBase.hh.

protocols::jd2::archive::AbstractArchiveBase::AbstractArchiveBase ( )

inline

Definition at line 64 of file ArchiveBase.hh.

Member Function Documentation

virtual bool protocols::jd2::archive::AbstractArchiveBase::finished ( ) const

pure virtual

is archive converged ?

Implemented in protocols::jd2::archive::DebugArchive, protocols::jd2::archive::ArchiveBase, protocols::abinitio::IterativeBase, and protocols::abinitio::IterativeAbrelax.

virtual void protocols::jd2::archive::AbstractArchiveBase::generate_batch ( )

pure virtual

create a new batch with manager().start_new_batch() and manager().finalize_batch();

Implemented in protocols::jd2::archive::DebugArchive, protocols::jd2::archive::ArchiveBase, protocols::abinitio::IterativeBase, protocols::abinitio::IterativeAbrelax, protocols::abinitio::IterativeFullatom, protocols::abinitio::HedgeArchive, and protocols::jd2::archive::VarianceStatisticsArchive.

virtual void protocols::jd2::archive::AbstractArchiveBase::idle ( )

pure virtual

do some computations on archive that can be done while we are waiting

Implemented in protocols::jd2::archive::ArchiveBase, protocols::abinitio::IterativeBase, and protocols::abinitio::IterativeAbrelax.

virtual void protocols::jd2::archive::AbstractArchiveBase::init_from_decoy_set ( core::io::silent::SilentFileData const & sfd)

pure virtual

Implemented in protocols::jd2::archive::ArchiveBase, protocols::abinitio::IterativeBase, protocols::jd2::archive::EvaluatedArchive, protocols::abinitio::IterativeAbrelax, protocols::abinitio::HedgeArchive, and protocols::jd2::archive::VarianceStatisticsArchive.

virtual void protocols::jd2::archive::AbstractArchiveBase::initialize ( )

pure virtual

Implemented in protocols::jd2::archive::ArchiveBase, protocols::abinitio::IterativeBase, protocols::jd2::archive::NormalizedEvaluatedArchive, protocols::abinitio::IterativeAbrelax, and protocols::abinitio::IterativeFullatom.

ArchiveManager& protocols::jd2::archive::AbstractArchiveBase::manager ( )

inline

access to the ArchiveManager (control of batches)

Definition at line 101 of file ArchiveBase.hh.

References manager_.

Referenced by protocols::abinitio::IterativeBase::collect_hedgeing_decoys_from_batches(), protocols::abinitio::IterativeFullatom::generate_batch(), protocols::abinitio::IterativeBase::generate_batch(), protocols::jd2::archive::DebugArchive::generate_batch(), protocols::abinitio::IterativeBase::increment_stage(), protocols::abinitio::IterativeBase::reassign_noesy_data(), protocols::abinitio::IterativeBase::rescore_nonlocal_archive(), and set_manager().

ArchiveManagerAP protocols::jd2::archive::AbstractArchiveBase::manager_ptr ( )

inlineprotected

Definition at line 112 of file ArchiveBase.hh.

References manager_.

Referenced by protocols::abinitio::IterativeBase::increment_stage().

std::string const& protocols::jd2::archive::AbstractArchiveBase::name ( ) const

inline

Definition at line 98 of file ArchiveBase.hh.

References name_.

virtual void protocols::jd2::archive::AbstractArchiveBase::read_structures	(	core::io::silent::SilentFileData &	returned_decoys,
		Batch const &	batch
	)

pure virtual

read 'returned_decoys' from 'batch' into archive.

Implemented in protocols::jd2::archive::ArchiveBase, protocols::abinitio::IterativeBase, protocols::jd2::archive::EvaluatedArchive, and protocols::abinitio::IterativeAbrelax.

virtual bool protocols::jd2::archive::AbstractArchiveBase::restore_from_file ( )

pure virtual

restore archive

Implemented in protocols::jd2::archive::ArchiveBase, protocols::jd2::archive::EvaluatedArchive, protocols::abinitio::IterativeAbrelax, and protocols::jd2::archive::NormalizedEvaluatedArchive.

virtual void protocols::jd2::archive::AbstractArchiveBase::save_status ( std::ostream & ) const

pure virtual

Implemented in protocols::jd2::archive::DebugArchive, protocols::jd2::archive::ArchiveBase, protocols::abinitio::IterativeBase, protocols::abinitio::IterativeAbrelax, and protocols::abinitio::HedgeArchive.

virtual void protocols::jd2::archive::AbstractArchiveBase::save_to_file ( std::string suffix = "")

pure virtual

save archive to file .. you can put 'suffix' at end of dirname to save other snapshots than the 'current'

Implemented in protocols::jd2::archive::EvaluatedArchive, protocols::jd2::archive::ArchiveBase, protocols::jd2::archive::NormalizedEvaluatedArchive, and protocols::abinitio::IterativeAbrelax.

virtual void protocols::jd2::archive::AbstractArchiveBase::set_manager ( ArchiveManagerAP manager)

inlinevirtual

Reimplemented in protocols::abinitio::IterativeAbrelax.

Definition at line 107 of file ArchiveBase.hh.

References manager(), and manager_.

Referenced by protocols::abinitio::IterativeAbrelax::set_manager().

void protocols::jd2::archive::AbstractArchiveBase::set_name ( std::string const & set)

inline

set name of archive ( used also for save_to_file and restore_from_file )

Definition at line 97 of file ArchiveBase.hh.

References name_.

Referenced by protocols::abinitio::HedgeArchive::HedgeArchive(), protocols::abinitio::IterativeBase::IterativeBase(), and protocols::jd2::archive::VarianceStatisticsArchive::VarianceStatisticsArchive().

virtual bool protocols::jd2::archive::AbstractArchiveBase::still_interested ( jd2::archive::Batch const & ) const

inlinevirtual

old-batches might be outdated and should not be computed anymore return true for this query if this is the case for old_batch

Reimplemented in protocols::abinitio::IterativeBase, and protocols::abinitio::IterativeAbrelax.

Definition at line 75 of file ArchiveBase.hh.

Referenced by protocols::jd2::archive::ArchiveBase::count_structure(), and protocols::abinitio::IterativeBase::still_interested().

Member Data Documentation

ArchiveManagerAP protocols::jd2::archive::AbstractArchiveBase::manager_

private

Definition at line 117 of file ArchiveBase.hh.

Referenced by manager(), manager_ptr(), and set_manager().

std::string protocols::jd2::archive::AbstractArchiveBase::name_

private

Definition at line 118 of file ArchiveBase.hh.

Referenced by name(), and set_name().

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

src/protocols/jd2/archive/ArchiveBase.hh
src/protocols/jd2/archive/ArchiveBase.cc

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation