protocols::neighbor Namespace Reference

Classes
class	Neighborhood
	A class to determine the neighborhood of a set of residues within a pose. More...

Typedefs
typedef bool(*	NGB_FUN_PTR) (core::conformation::Residue const &r1, core::conformation::Residue const &r2, core::pose::Pose const &ps)
	type of functions that determine whether two residues are neighbor of one another More...

Functions
static basic::Tracer	TR ("protocols.neighbor")
bool	in_nrg_graph (Residue const &r1, Residue const &r2, Pose const &ps)
	: returns true iff r2 is a residue whose node in the energy graph is connected to r1's. More...
bool	in_ngbat_sphere (Residue const &r1, Residue const &r2, Pose const &)
	: returns true iff r2's neighbor atom falls within a cutoff distance of r1's neighbor atom. More...

Typedef Documentation

NGB_FUN_PTR

typedef bool(* protocols::neighbor::NGB_FUN_PTR) (core::conformation::Residue const &r1, core::conformation::Residue const &r2, core::pose::Pose const &ps)

type of functions that determine whether two residues are neighbor of one another

Function Documentation

in_ngbat_sphere()

bool protocols::neighbor::in_ngbat_sphere	(	Residue const &	r1,
		Residue const &	r2,
		Pose const &
	)

: returns true iff r2's neighbor atom falls within a cutoff distance of r1's neighbor atom.

Parameters

[in]	r1	residue r1
[in]	r2	residue r2
[in]	ps	pose to which both residues belong

The squared cutoff distance is specified within the function by constant DCUT2.

References protocols::hybridization::r1, and protocols::hybridization::r2.

in_nrg_graph()

bool protocols::neighbor::in_nrg_graph	(	Residue const &	r1,
		Residue const &	r2,
		Pose const &	ps
	)

: returns true iff r2 is a residue whose node in the energy graph is connected to r1's.

Parameters

[in]	r1	residue r1
[in]	r2	residue r2
[in]	ps	pose to which both residues belong

References core::pose::Pose::energies(), core::scoring::Energies::energy_graph(), protocols::hybridization::r1, and protocols::hybridization::r2.

TR()

static basic::Tracer protocols::neighbor::TR ( "protocols.neighbor"  )

static

Referenced by protocols::neighbor::Neighborhood::print_ngb_mask().