RandomMover picks a random move and applies it. More...

#include <MoverContainer.hh>

Inheritance diagram for protocols::moves::RandomMover:

Public Member Functions
	RandomMover ()
	APL NOTE: Liz, I'm making up a value of "1.0" here, because you haven't set this value. Is this a reasonable initial value? More...

	RandomMover (RandomMover const &)
	Copy constructor. Performs a deep copy of all contained movers. More...

MoverOP	clone () const override
	Return a clone of the Mover object. More...

MoverOP	fresh_instance () const override
	Generates a new Mover object freshly created with the default ctor. More...

void	apply (core::pose::Pose &pose) override
	Main Method. More...

std::string	get_name_individual_mover (core::Size index)

core::Size	get_index_of_last_mover_used ()
	Get the index of the last Mover used by the RandomMover (0 means RandomMover has not been applied yet) More...

core::Real	last_proposal_density_ratio () override

void	parse_my_tag (utility::tag::TagCOP tag, basic::datacache::DataMap &) override
	Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing. More...

std::string	get_name () const override
	Each derived class must specify its name. The class name. More...

Public Member Functions inherited from protocols::moves::MoverContainer
	MoverContainer ()

	MoverContainer (MoverContainer const &source)
	to be called by derived-class clone() methods; copy all data from the source MoverContainer More...

void	add_mover (MoverOP mover_in, core::Real weight_in=1.0)
	Adds a mover to the end of this container. More...

std::string	get_mover (core::Size index) const

void	clear ()

void	set_input_pose (PoseCOP pose) override
	Sets the input Pose for both the container and the contained movers, for rmsd. More...

void	set_native_pose (PoseCOP pose) override
	setter for native poses contained for rms -— we should get rid of this method? it is widely used, but a bit unsafe More...

void	set_current_tag (std::string const &new_tag) override

core::Size	nr_moves ()

core::Size	size () const

MoverOP	front ()

utility::vector0< core::Real > const &	weights () const

utility::vector0< MoverOP > const &	movers () const

void	provide_citation_info (basic::citation_manager::CitationCollectionList &) const override
	Provide the citation. More...

Public Member Functions inherited from protocols::moves::Mover
	Mover ()

virtual MoverOP	create ()

MoverCOP	get_self_ptr () const

MoverOP	get_self_ptr ()

MoverCAP	get_self_weak_ptr () const

MoverAP	get_self_weak_ptr ()

	Mover (std::string const &type_name)
	sets the type for a mover; name_ has been removed (2010/05/14) More...

virtual void	test_move (Pose &pose)
	: Unit test support function. Apply one move to a given pose. Allows extra test specific functions to be called before applying More...

virtual bool	reinitialize_for_each_job () const
	Inform the Job Distributor (August '08 vintage) whether this object needs to be freshly regenerated on each use. More...

virtual bool	reinitialize_for_new_input () const
	Inform the Job Distributor (August '08 vintage) whether this object needs to be regenerated when the input pose is about to change, (for example, if the Mover has special code on the first apply() that is only valid for that one input pose). More...

MoverStatus	get_last_move_status () const
	end parser interface, start Job Distributor interface///////////// More...

void	reset_status ()
	resets status to SUCCESS, meant to be used before an apply(). The job distributor (august 08 vintage) uses this to ensure non-accumulation of status across apply()s. More...

virtual core::pose::PoseOP	get_additional_output ()
	Mechanism by which a mover may return multiple output poses from a single input pose. More...

void	set_type (std::string const &setting)
	Set the 'type' string. More...

std::string	get_type () const

void	type (const std::string &type_in)
	Set the 'type' string. More...

std::string const &	type () const
	Get the set 'type' string. More...

PoseCOP	get_input_pose () const

PoseCOP	get_native_pose () const

void	set_current_job (protocols::jobdist::BasicJobCOP job)

jobdist::BasicJobCOP	get_current_job () const

std::string	get_current_tag () const
	A tag is a unique identifier used to identify structures produced by this Mover. get_current_tag() returns the tag, and set_current_tag( std::string tag ) sets the tag. This functionality is not intended for use with the 2008 job distributor. More...

virtual void	show (std::ostream &output=std::cout) const
	Outputs details about the Mover, including current settings. More...

virtual void	clear_info ()
	Strings container can be used to return miscellaneous info (as std::string) from a mover, such as notes about the results of apply(). The job distributor (Apr 09 vintage) will check this function to see if your protocol wants to add string info to the Job that ran this mover. One way this can be useful is that later, a JobOutputter may include/append this info to an output file. More...

virtual Strings &	info ()
	non-const accessor More...

virtual Strings const &	info () const
	const accessor More...

Static Public Member Functions
static std::string	mover_name ()

static void	provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)

Static Public Member Functions inherited from protocols::moves::Mover
static std::string	name ()

static void	register_options ()
	Overload this static method if you access options within the mover. More...

Private Member Functions
void	set_index_of_last_mover_used (core::Size index_of_last_mover_used)
	Set the index of the last Mover used by the RandomMover (0 means RandomMover has not been applied yet) More...

Private Attributes
core::Size	nmoves_

core::Real	last_proposal_density_ratio_

core::Size	index_of_last_mover_used_ = 0

Additional Inherited Members
Public Types inherited from protocols::moves::Mover
typedef utility::tag::TagCOP	TagCOP

typedef core::pose::Pose	Pose

typedef core::pose::PoseCOP	PoseCOP

typedef std::list< std::string >	Strings

Protected Member Functions inherited from protocols::moves::Mover
void	set_last_move_status (MoverStatus status)
	nonvirtual setter for MoverStatus last_status_. Protected means that only the mover itself will be able to change its own status. The job distributor (august 08 vintage) is aware of status set with this function and will do what the MoverStatus says. More...

Protected Attributes inherited from protocols::moves::MoverContainer
utility::vector0< core::Real >	weight_
	relative weight when part of MoverContainer. More...

utility::vector0< MoverOP >	movers_

Detailed Description

RandomMover picks a random move and applies it.

If nmoves is greater than 1, it repeats this process nmoves times for each call to apply(). This mover supports weights — the individual moves are sampled with frequency proportional to their weight given with add_mover( mover, weight );

Constructor & Destructor Documentation

protocols::moves::RandomMover::RandomMover ( )

inline

APL NOTE: Liz, I'm making up a value of "1.0" here, because you haven't set this value. Is this a reasonable initial value?

protocols::moves::RandomMover::RandomMover ( RandomMover const & )

default

Copy constructor. Performs a deep copy of all contained movers.

Member Function Documentation

void protocols::moves::RandomMover::apply ( core::pose::Pose & )

overridevirtual

Main Method.

Implements protocols::moves::MoverContainer.

References protocols::moves::Mover::get_last_move_status(), last_proposal_density_ratio_, protocols::moves::MoverContainer::movers_, nmoves_, core::scoring::rg, set_index_of_last_mover_used(), protocols::moves::Mover::set_last_move_status(), core::simple_metrics::metrics::sum, protocols::moves::TR(), protocols::moves::Mover::type(), and protocols::moves::MoverContainer::weight_.

Referenced by protocols::rbsegment_relax::AutoRBMover::apply().

MoverOP protocols::moves::RandomMover::clone ( ) const

overridevirtual

Return a clone of the Mover object.

clone is meant to return an OP'ed deep copy of this object. This really should be a pure virtual in the base class, but adding pure virtuals to Mover would massively disrupt the code. This default implementation crashes at runtime instead of compiletime if you try to call it. If this code is causing you problems, your Mover needs to override this function.

Reimplemented from protocols::moves::Mover.

MoverOP protocols::moves::RandomMover::fresh_instance ( ) const

overridevirtual

Generates a new Mover object freshly created with the default ctor.

fresh_instance is meant to return a new object of this class, created with the default constructor. This really should be a pure virtual in the base class, but adding pure virtuals to Mover would massively disrupt the code. This default implementation crashes at runtime instead of compiletime if you try to call it. If this code is causing you problems, your Mover needs to override this function. This is used by the August 08 job distributor.

Reimplemented from protocols::moves::Mover.

core::Size protocols::moves::RandomMover::get_index_of_last_mover_used ( )

Get the index of the last Mover used by the RandomMover (0 means RandomMover has not been applied yet)

References index_of_last_mover_used_.

std::string protocols::moves::RandomMover::get_name ( ) const

overridevirtual

Each derived class must specify its name. The class name.

Implements protocols::moves::Mover.

References mover_name().

std::string protocols::moves::RandomMover::get_name_individual_mover ( core::Size index )

References protocols::moves::MoverContainer::movers_, and protocols::moves::Mover::name().

core::Real protocols::moves::RandomMover::last_proposal_density_ratio ( )

overridevirtual

Reimplemented from protocols::moves::Mover.

References last_proposal_density_ratio_.

std::string protocols::moves::RandomMover::mover_name ( )

static

Referenced by get_name(), protocols::moves::SwitchMover::get_name(), protocols::moves::RandomMoverCreator::keyname(), provide_xml_schema(), and protocols::moves::SwitchMover::provide_xml_schema().

void protocols::moves::RandomMover::parse_my_tag	(	utility::tag::TagCOP	tag,
		basic::datacache::DataMap &	data
	)

overridevirtual

Called by MoverFactory when constructing new Movers. Takes care of the specific mover's parsing.

Some movers need not be parsed, so we shouldn't force people to reimplement this method. However, we should be chatty about the fact that someone is using a RosettaScripts interface to a mover which didn't define parse_my_tag()

Reimplemented from protocols::moves::Mover.

References protocols::moves::MoverContainer::add_mover(), protocols::moves::find_mover_or_die(), and nmoves_.

void protocols::moves::RandomMover::provide_xml_schema ( utility::tag::XMLSchemaDefinition & xsd )

static

References mover_name(), and protocols::moves::xsd_type_definition_w_attributes().

Referenced by protocols::moves::RandomMoverCreator::provide_xml_schema().

void protocols::moves::RandomMover::set_index_of_last_mover_used ( core::Size index_of_last_mover_used )

private

Set the index of the last Mover used by the RandomMover (0 means RandomMover has not been applied yet)

References index_of_last_mover_used_.

Referenced by apply().