Rosetta  2021.16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
core::fragment::picking_old::vall::VallSection Class Reference

class implementing the Book concept for a continuous section of lines in the Vall library More...

#include <VallSection.hh>

Inheritance diagram for core::fragment::picking_old::vall::VallSection:
Inheritance graph
[legend]

Public Types

typedef Super::PageConstIterator PageConstIterator
 typedef for Book concept More...
 
typedef Super::PageIterator PageIterator
 typedef for Book concept More...
 
typedef PageConstIterator VallResidueConstIterator
 
typedef PageIterator VallResidueIterator
 
- Public Types inherited from core::fragment::picking_old::concepts::Book< VallResidues >
typedef core::Size Size
 
typedef VallResidues::Page Page
 
typedef
VallResidues::const_iterator 
PageConstIterator
 
typedef VallResidues::iterator PageIterator
 

Public Member Functions

VallResidue const & operator[] (Size const idx) const
 access a specific VallResidue within this section, 1-based indexing More...
 
void append_residue (VallResidue const &r)
 append a residue to the end of this section More...
 
void reindex_residues ()
 re-index VallResidues within this library so they number 1 .. n More...
 
Size index () const
 stores the 1-based indexing for accessing this section via VallLibrary::operator [] More...
 
void index (Size const idx)
 stores the 1-based indexing for accessing this section via VallLibrary::operator [] More...
 
void reserve (Size const n)
 ensure storage currently allocated for residues is at least the given size More...
 
void tighten_memory ()
 tighten memory usage More...
 
- Public Member Functions inherited from core::fragment::picking_old::concepts::Book< VallResidues >
 Book ()
 default constructor More...
 
 Book (VallResiduesconst &pages)
 Pages constructor. More...
 
 ~Book ()
 default destructor More...
 
PageConstIterator begin () const
 return an iterator that points to the first Page in this book More...
 
PageIterator begin ()
 return an iterator that points to the first Page in this book More...
 
PageConstIterator end () const
 return an iterator that points just beyond the last Page of this book More...
 
PageIterator end ()
 return an iterator that points just beyond the last Page of this book More...
 
Size size () const
 number of pages in the book More...
 
void clear ()
 clear the book More...
 

Private Types

typedef
core::fragment::picking_old::concepts::Book
< VallResidues
Super
 

Private Member Functions

VallResidues const & residues () const
 return residues container More...
 
VallResiduesresidues ()
 return residues container More...
 

Private Attributes

Size index_ = 0
 stores the 1-based indexing for accessing this section via VallLibrary::operator [] More...
 

Additional Inherited Members

- Protected Member Functions inherited from core::fragment::picking_old::concepts::Book< VallResidues >
VallResiduesconst & pages () const
 return the pages in this book More...
 
VallResidues & pages ()
 return the pages in this book More...
 

Detailed Description

class implementing the Book concept for a continuous section of lines in the Vall library

Member Typedef Documentation

typedef for Book concept

typedef for Book concept

Member Function Documentation

void core::fragment::picking_old::vall::VallSection::append_residue ( VallResidue const &  r)
inline
Size core::fragment::picking_old::vall::VallSection::index ( ) const
inline

stores the 1-based indexing for accessing this section via VallLibrary::operator []

References index_.

void core::fragment::picking_old::vall::VallSection::index ( Size const  idx)
inline
VallResidue const& core::fragment::picking_old::vall::VallSection::operator[] ( Size const  idx) const
inline

access a specific VallResidue within this section, 1-based indexing

References residues().

void core::fragment::picking_old::vall::VallSection::reindex_residues ( )
inline
void core::fragment::picking_old::vall::VallSection::reserve ( Size const  n)
inline

ensure storage currently allocated for residues is at least the given size

References residues().

VallResidues const& core::fragment::picking_old::vall::VallSection::residues ( ) const
inlineprivate
VallResidues& core::fragment::picking_old::vall::VallSection::residues ( )
inlineprivate
void core::fragment::picking_old::vall::VallSection::tighten_memory ( )
inline

tighten memory usage

Shrinks the capacity of the VallResidues by performing a swap, so this operation will effectively require a similar amount of memory as the current residue object.

References residues(), and core::fragment::picking_old::concepts::Book< VallResidues >::size().

Member Data Documentation

Size core::fragment::picking_old::vall::VallSection::index_ = 0
private

stores the 1-based indexing for accessing this section via VallLibrary::operator []

Referenced by append_residue(), and index().


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