Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Attributes | List of all members
core::scoring::saxs::DistanceHistogram Class Reference

#include <DistanceHistogram.hh>

Inheritance diagram for core::scoring::saxs::DistanceHistogram:
Inheritance graph
[legend]

Public Member Functions

 DistanceHistogram (void)
 Create a histogram that collects distances between two predefined atom types. More...
 
Size operator() (Real distance) const
 Returns the number of counts for a given distance. More...
 
Size get (Real distance) const
 Returns the number of counts for a given distance. More...
 
Size get (Size bin) const
 Returns the number of counts for a given bin. More...
 
Real distance (Size bin) const
 tells waht distance falls into a certain bin More...
 
void insert (Real distance)
 Adds a distance observation to the histogram. More...
 
Size size ()
 Returns the size of this histogram. More...
 
void zeros ()
 Clears this histogram by filling each cell with 0.0. More...
 
Size total () const
 Returns the total number of counts in this histogram. More...
 
Size last_nonempty_bin () const
 

Private Attributes

Real factor_
 
Real max_dist_
 
Size last_nonempty_bin_
 
utility::vector1< Sizeh_
 

Constructor & Destructor Documentation

core::scoring::saxs::DistanceHistogram::DistanceHistogram ( void  )
inline

Create a histogram that collects distances between two predefined atom types.

Member Function Documentation

Real core::scoring::saxs::DistanceHistogram::distance ( Size  bin) const
inline

tells waht distance falls into a certain bin

References factor_.

Referenced by get().

Size core::scoring::saxs::DistanceHistogram::get ( Real  distance) const
inline

Returns the number of counts for a given distance.

References distance(), factor_, and h_.

Size core::scoring::saxs::DistanceHistogram::get ( Size  bin) const
inline

Returns the number of counts for a given bin.

References h_.

void core::scoring::saxs::DistanceHistogram::insert ( Real  distance)
inline

Adds a distance observation to the histogram.

References protocols::match::upstream::b, factor_, h_, and last_nonempty_bin_.

Size core::scoring::saxs::DistanceHistogram::last_nonempty_bin ( ) const
inline

References last_nonempty_bin_.

Size core::scoring::saxs::DistanceHistogram::operator() ( Real  distance) const
inline

Returns the number of counts for a given distance.

References factor_, and h_.

Size core::scoring::saxs::DistanceHistogram::size ( )
inline

Returns the size of this histogram.

References h_.

Size core::scoring::saxs::DistanceHistogram::total ( ) const
inline

Returns the total number of counts in this histogram.

References h_.

void core::scoring::saxs::DistanceHistogram::zeros ( )
inline

Clears this histogram by filling each cell with 0.0.

References h_, and last_nonempty_bin_.

Member Data Documentation

Real core::scoring::saxs::DistanceHistogram::factor_
private

Referenced by distance(), get(), insert(), and operator()().

utility::vector1<Size> core::scoring::saxs::DistanceHistogram::h_
private

Referenced by get(), insert(), operator()(), size(), total(), and zeros().

Size core::scoring::saxs::DistanceHistogram::last_nonempty_bin_
private

Referenced by insert(), last_nonempty_bin(), and zeros().

Real core::scoring::saxs::DistanceHistogram::max_dist_
private

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