Public Member Functions | Private Member Functions | Private Attributes | List of all members
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:
Inheritance graph

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::Sizengbs

Detailed Description

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

Constructor & Destructor Documentation

◆ Neighborhood()

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

Neighborhood's constructor.

[in]setpose indexes of the residues whose neighborhood is to be computed
[in]psthe pose
[in]ngb_funfunction 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

◆ get()

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

References ngbs.

◆ print_ngb_mask()

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

: 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, and protocols::neighbor::TR().

Member Data Documentation

◆ is_ngb

NGB_FUN_PTR protocols::neighbor::Neighborhood::is_ngb

Referenced by Neighborhood().

◆ ngb_mask

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

Referenced by Neighborhood(), and print_ngb_mask().

◆ ngbs

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

Referenced by get(), and Neighborhood().

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