Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Types | Private Attributes | List of all members
protocols::nonlocal::Region Class Reference

#include <Region.hh>

Inheritance diagram for protocols::nonlocal::Region:
Inheritance graph
[legend]

Public Member Functions

 ~Region () override
 Automatically generated virtual destructor for class deriving directly from VirtualBase. More...
 
 Region (core::Size start_pos, core::Size stop_pos)
 Creates a new region with the specified start/stop residues. More...
 
core::Size start () const
 Returns the starting position of this region O(1) More...
 
core::Size stop () const
 Returns the stopping position of this region O(1) More...
 
core::Size length () const
 Returns the length of this region. Makes no assumption about directionality. That is, Region(3,5).length() == Region(5,3).length(). O(1) More...
 
bool increasing () const
 Returns true if start <= stop, false otherwise. More...
 
bool decreasing () const
 Returns true if stop <= start, false otherwise. More...
 

Private Types

typedef core::Size Size
 

Private Attributes

core::Size start_
 The starting position of the contiguous sequence. More...
 
core::Size stop_
 The ending position of the contiguous sequence. More...
 

Member Typedef Documentation

Constructor & Destructor Documentation

protocols::nonlocal::Region::~Region ( )
overridedefault

Automatically generated virtual destructor for class deriving directly from VirtualBase.

Auto-generated virtual destructor

protocols::nonlocal::Region::Region ( core::Size  start_pos,
core::Size  stop_pos 
)

Creates a new region with the specified start/stop residues.

Member Function Documentation

bool protocols::nonlocal::Region::decreasing ( ) const

Returns true if stop <= start, false otherwise.

References start(), and stop().

bool protocols::nonlocal::Region::increasing ( ) const

Returns true if start <= stop, false otherwise.

References start(), and stop().

Referenced by length().

core::Size protocols::nonlocal::Region::length ( ) const

Returns the length of this region. Makes no assumption about directionality. That is, Region(3,5).length() == Region(5,3).length(). O(1)

References increasing(), start(), and stop().

core::Size protocols::nonlocal::Region::start ( ) const

Returns the starting position of this region O(1)

References start_.

Referenced by decreasing(), increasing(), and length().

core::Size protocols::nonlocal::Region::stop ( ) const

Returns the stopping position of this region O(1)

References stop_.

Referenced by decreasing(), increasing(), and length().

Member Data Documentation

core::Size protocols::nonlocal::Region::start_
private

The starting position of the contiguous sequence.

Referenced by start().

core::Size protocols::nonlocal::Region::stop_
private

The ending position of the contiguous sequence.

Referenced by stop().


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