#include <AnnealableGraphBase.hh>

Inheritance diagram for core::pack::interaction_graph::AnnealableGraphBase:

Public Member Functions
	AnnealableGraphBase ()
	Constructor. More...

	AnnealableGraphBase (AnnealableGraphBase const &src)
	Copy constructor. More...

	~AnnealableGraphBase () override
	Destructor. More...

virtual int	get_num_nodes () const =0
	Get the number of nodes in the graph. More...

virtual int	get_num_states_for_node (int node) const =0
	Get the number of states for a node in the graph. More...

virtual int	get_num_total_states () const =0
	Get the total number of states. More...

virtual void	prepare_graph_for_simulated_annealing ()=0
	Utility signal. More...

virtual void	blanket_assign_state_0 ()=0
	State initialization. More...

virtual bool	any_vertex_state_unassigned () const =0
	Is any state of any vertex unassigned? More...

virtual core::PackerEnergy	set_state_for_node (int node_ind, int new_state)=0
	Explicit state modification for a node. More...

virtual core::PackerEnergy	set_network_state (ObjexxFCL::FArray1_int &node_states)=0
	Explicit state modification for the network. More...

virtual void	consider_substitution (int node_ind, int new_state, core::PackerEnergy &delta_energy, core::PackerEnergy &prev_energy_for_node)=0
	Consider switching node "node_ind" to state "new_state". More...

virtual core::PackerEnergy	commit_considered_substitution ()=0
	Accept a considered substitution (i.e. make the substitution permanent; commit it). More...

virtual core::PackerEnergy	get_energy_current_state_assignment ()=0
	Get the energy resulting from the current set of state assignments. More...

virtual void	set_errorfull_deltaE_threshold (core::PackerEnergy deltaE)=0
	Set an error threshold. More...

virtual void	clean_up_after_packing (core::pose::Pose &pose)
	Provide the opportunity for an AnnealableGraph to clean up cached data in the pose or inside itself after packing. More...

Constructor & Destructor Documentation

core::pack::interaction_graph::AnnealableGraphBase::AnnealableGraphBase ( )

default

Constructor.

core::pack::interaction_graph::AnnealableGraphBase::AnnealableGraphBase ( AnnealableGraphBase const & src )

default

Copy constructor.

core::pack::interaction_graph::AnnealableGraphBase::~AnnealableGraphBase ( )

overridedefault

Destructor.

Member Function Documentation

virtual bool core::pack::interaction_graph::AnnealableGraphBase::any_vertex_state_unassigned ( ) const

pure virtual

Is any state of any vertex unassigned?

Must be implemented by derived classes.

Implemented in core::pack::interaction_graph::InteractionGraphBase, core::pack::interaction_graph::ResidueArrayAnnealingEvaluator, and core::pack::interaction_graph::MultiplexedAnnealableGraph.

virtual void core::pack::interaction_graph::AnnealableGraphBase::blanket_assign_state_0 ( )

pure virtual

State initialization.

Must be implemented by derived classes.

void core::pack::interaction_graph::AnnealableGraphBase::clean_up_after_packing ( core::pose::Pose & pose )

virtual

Provide the opportunity for an AnnealableGraph to clean up cached data in the pose or inside itself after packing.

Base class function does nothing; may be overridden in derived classes.

Author: Vikram K. Mulligan (vmull.nosp@m.ig@u.nosp@m.w.edu).

Reimplemented in core::pack::interaction_graph::ResidueArrayAnnealingEvaluator, and core::pack::interaction_graph::MultiplexedAnnealableGraph.

virtual core::PackerEnergy core::pack::interaction_graph::AnnealableGraphBase::commit_considered_substitution ( )

pure virtual

Accept a considered substitution (i.e. make the substitution permanent; commit it).

Must be implemented by derived classes.

virtual void core::pack::interaction_graph::AnnealableGraphBase::consider_substitution	(	int	node_ind,
		int	new_state,
		core::PackerEnergy &	delta_energy,
		core::PackerEnergy &	prev_energy_for_node
	)

pure virtual

Consider switching node "node_ind" to state "new_state".

Must be implemented by derived classes.

Parameters

[in]	node_ind	The node index.
[in]	new_state	The state index that we are considering switching TO.
[out]	delta_energy	The change in energy that results from the switch under consideration, computed by this function.
[out]	prev_energy_for_node	The energy of this node prior to the substitutio, returned by this function.

virtual core::PackerEnergy core::pack::interaction_graph::AnnealableGraphBase::get_energy_current_state_assignment ( )

pure virtual

Get the energy resulting from the current set of state assignments.

Must be implemented by derived classes.

virtual int core::pack::interaction_graph::AnnealableGraphBase::get_num_nodes ( ) const

pure virtual

Get the number of nodes in the graph.

Must be implemented by derived classes.

Implemented in core::pack::interaction_graph::InteractionGraphBase, core::pack::interaction_graph::ResidueArrayAnnealingEvaluator, and core::pack::interaction_graph::MultiplexedAnnealableGraph.

virtual int core::pack::interaction_graph::AnnealableGraphBase::get_num_states_for_node ( int node ) const

pure virtual

Get the number of states for a node in the graph.

Must be implemented by derived classes.

Implemented in core::pack::interaction_graph::InteractionGraphBase, core::pack::interaction_graph::ResidueArrayAnnealingEvaluator, and core::pack::interaction_graph::MultiplexedAnnealableGraph.

virtual int core::pack::interaction_graph::AnnealableGraphBase::get_num_total_states ( ) const

pure virtual

Get the total number of states.

Must be implemented by derived classes.

Implemented in core::pack::interaction_graph::InteractionGraphBase, core::pack::interaction_graph::ResidueArrayAnnealingEvaluator, and core::pack::interaction_graph::MultiplexedAnnealableGraph.

virtual void core::pack::interaction_graph::AnnealableGraphBase::prepare_graph_for_simulated_annealing ( )

pure virtual

Utility signal.

Must be implemented by derived classes.

Implemented in core::pack::interaction_graph::DoubleLazyInteractionGraph, core::pack::interaction_graph::LinearMemoryInteractionGraph, core::pack::interaction_graph::InteractionGraphBase, core::pack::interaction_graph::SymmLinearMemoryInteractionGraph, core::pack::interaction_graph::SymmMinimalistInteractionGraph, core::pack::interaction_graph::ResidueArrayAnnealingEvaluator, and core::pack::interaction_graph::MultiplexedAnnealableGraph.

virtual void core::pack::interaction_graph::AnnealableGraphBase::set_errorfull_deltaE_threshold ( core::PackerEnergy deltaE )

pure virtual

Set an error threshold.

Must be implemented by derived classes.

virtual core::PackerEnergy core::pack::interaction_graph::AnnealableGraphBase::set_network_state ( ObjexxFCL::FArray1_int & node_states )

pure virtual

Explicit state modification for the network.

Must be implemented by derived classes.

virtual core::PackerEnergy core::pack::interaction_graph::AnnealableGraphBase::set_state_for_node	(	int	node_ind,
		int	new_state
	)

pure virtual

Explicit state modification for a node.

Must be implemented by derived classes.

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

src/core/pack/interaction_graph/AnnealableGraphBase.hh
src/core/pack/interaction_graph/AnnealableGraphBase.cc

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation