#include <IMP/core/NeighborsTable.h>

Inheritance diagram for IMP::core::NeighborsTable:

Public Member Functions
	NeighborsTable (kernel::PairContainer *input, std::string name="CloseNeighborsTable%1%")

const kernel::ParticleIndexes &	get_neighbors (kernel::ParticleIndex pi) const

virtual std::string	get_type_name () const

virtual ::IMP::base::VersionInfo	get_version_info () const
	Get information about the module and version of the object.

Public Member Functions inherited from IMP::kernel::ScoreState
	ScoreState (kernel::Model *m, std::string name)

void	after_evaluate (DerivativeAccumulator *accpt)
	Do post evaluation work if needed.

void	before_evaluate ()
	Force update of the structure.

Public Member Functions inherited from IMP::kernel::ModelObject
	ModelObject (kernel::Model *m, std::string name)

bool	get_has_dependencies () const
	Return whether this object has dependencies computed.

bool	get_has_required_score_states () const

ModelObjectsTemp	get_inputs () const

ModelObjectsTemps	get_interactions () const

Model *	get_model () const

ModelObjectsTemp	get_outputs () const

const ScoreStatesTemp &	get_required_score_states () const

void	set_has_dependencies (bool tf)

void	set_has_required_score_states (bool tf)

Public Member Functions inherited from IMP::base::Object
virtual void	clear_caches ()

virtual void	do_destroy ()

CheckLevel	get_check_level () const

LogLevel	get_log_level () const

void	set_check_level (CheckLevel l)

void	set_log_level (LogLevel l)
	Set the logging level used in this object. More...

void	set_was_used (bool tf) const

void	show (std::ostream &out=std::cout) const

const std::string &	get_name () const

void	set_name (std::string name)

Protected Member Functions
virtual void	do_after_evaluate (DerivativeAccumulator *)

virtual void	do_before_evaluate ()

virtual kernel::ModelObjectsTemp	do_get_inputs () const

virtual kernel::ModelObjectsTemp	do_get_outputs () const

Protected Member Functions inherited from IMP::kernel::ModelObject
virtual ModelObjectsTemps	do_get_interactions () const

virtual void	handle_set_has_required_score_states (bool)

Protected Member Functions inherited from IMP::base::Object
	Object (std::string name)
	Construct an object with the given name. More...

Detailed Description

Maintain a table that can be used to look up the neighbors of particles. That is, you can efficiently find all particles that are within a certain distance of a passed one.

As with the container::ClosePairContainer, there may be some neighbors returned that are not close neighbors, but all close neighbors will be returned.

Definition at line 29 of file NeighborsTable.h.

Member Function Documentation

virtual kernel::ModelObjectsTemp IMP::core::NeighborsTable::do_get_inputs ( ) const

protectedvirtual

Get any Particle, Container or other ModelObjects read by this during evaluation. If you read everything in a container, you can just return that container.

Implements IMP::kernel::ModelObject.

Definition at line 35 of file NeighborsTable.h.

virtual kernel::ModelObjectsTemp IMP::core::NeighborsTable::do_get_outputs ( ) const

protectedvirtual

Get any Particle, Container or other ModelObjects changed by this during evaluation. This is only useful for ScoreStates, at the moment.

Implements IMP::kernel::ModelObject.

Definition at line 38 of file NeighborsTable.h.

const kernel::ParticleIndexes& IMP::core::NeighborsTable::get_neighbors ( kernel::ParticleIndex pi ) const

Return all kernel::ParticleIndexes that are within the distance threshold of this one (plus some that are aren't, for efficiency).

Definition at line 49 of file NeighborsTable.h.

Here is the call graph for this function:

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

NeighborsTable.h

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation