protocols::neighbor::Neighborhood Class Reference

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

#include <Neighborhood.hh>

Inheritance diagram for protocols::neighbor::Neighborhood:

Public Member Functions
	Neighborhood (utility::vector1< core::Size > const &set, core::pose::Pose const &ps, NGB_FUN_PTR ngb_fun)
	Neighborhood's constructor. More...
utility::vector1< core::Size > const &	get () const

Private Member Functions
void	print_ngb_mask () const
	: prints the neighbor mask as a binary string More...

Private Attributes
NGB_FUN_PTR	is_ngb
utility::vector1< bool >	ngb_mask
utility::vector1< core::Size >	ngbs

Detailed Description

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

Constructor & Destructor Documentation

protocols::neighbor::Neighborhood::Neighborhood	(	utility::vector1< core::Size > const &	set,
		core::pose::Pose const &	ps,
		NGB_FUN_PTR	ngb_fun
	)

Neighborhood's constructor.

Parameters

[in]	set	pose indexes of the residues whose neighborhood is to be computed
[in]	ps	the pose
[in]	ngb_fun	function determining whether two residues are neighbors of one another

At the end of this function, ngb_mask[i], for i in {1,...,NPS} such that i is not a member of set, is true iff is_ngb(R_j, N_i, ps) equals true for at least one j in {1,...,NSET}, where R_j indicates ps.residue(set[j]) and N_i indicates ps.residue(i); for i in {1,...,NPS} such that i is a member of set, ngb_mask[i] equals false.

References is_ngb, ngb_mask, ngbs, core::pose::Pose::residue(), and core::pose::Pose::size().

Member Function Documentation

utility::vector1<core::Size> const& protocols::neighbor::Neighborhood::get ( ) const

inline

References ngbs.

void protocols::neighbor::Neighborhood::print_ngb_mask ( ) const

private

: prints the neighbor mask as a binary string

: the ith output digit equals 1 if the ith element in the mask is true; it equals 0 if the ith element is false (i=1,...,SIZ).

References ngb_mask.

Member Data Documentation

NGB_FUN_PTR protocols::neighbor::Neighborhood::is_ngb

private

Referenced by Neighborhood().

utility::vector1<bool> protocols::neighbor::Neighborhood::ngb_mask

private

Referenced by Neighborhood(), and print_ngb_mask().

utility::vector1<core::Size> protocols::neighbor::Neighborhood::ngbs

private

Referenced by get(), and Neighborhood().

---

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

• src/protocols/neighbor/Neighborhood.hh
• src/protocols/neighbor/Neighborhood.cc