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 | List of all members
core::fragment::picking_old::vall::VallLibrary Class Reference

Vall fragment library. More...

#include <VallLibrary.hh>

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

Public Types

typedef Super::Size Size
 
typedef Super::BookConstIterator BookConstIterator
 typedef for Library concept More...
 
typedef Super::BookIterator BookIterator
 typedef for Library concept More...
 
typedef BookConstIterator VallSectionConstIterator
 
typedef BookIterator VallSectionIterator
 
- Public Types inherited from core::fragment::picking_old::concepts::Library< VallSections >
typedef core::Size Size
 
typedef VallSections::Book Book
 
typedef
VallSections::const_iterator 
BookConstIterator
 
typedef VallSections::iterator BookIterator
 

Public Member Functions

VallSection const & operator[] (Size idx) const
 access a specific VallSection within this section, 1-based indexing More...
 
void add_section (VallSection const &section)
 brief add a section to the end of this library More...
 
VallSection const & last_section () const
 access the last section in thie library More...
 
VallSectionlast_section ()
 access the last section in thie library More...
 
Size n_residues () const
 total number of residues in the library More...
 
void reindex_sections ()
 re-index VallSections within this library so they number 1 .. n More...
 
void reserve (Size n)
 ensure storage currently allocated for VallSections is at least the given size More...
 
void tighten_memory (bool const sections_only=true)
 tighten memory usage More...
 
- Public Member Functions inherited from core::fragment::picking_old::concepts::Library< VallSections >
 Library ()
 default constructor More...
 
 Library (VallSectionsconst &books)
 Books constructor. More...
 
 ~Library ()
 default destructor More...
 
BookConstIterator begin () const
 return an iterator that points to the first Book in this library More...
 
BookIterator begin ()
 return an iterator that points to the first Book in this library More...
 
BookConstIterator end () const
 return an iterator that points beyond the last Book in this library More...
 
BookIterator end ()
 return an iterator that points beyond the last Book in this library More...
 
Size size () const
 number of books in the library More...
 
void clear ()
 clear the library More...
 

Private Types

typedef
core::fragment::picking_old::concepts::Library
< VallSections
Super
 

Private Member Functions

VallSections const & sections () const
 return sections container More...
 
VallSectionssections ()
 return sections container More...
 

Additional Inherited Members

- Protected Member Functions inherited from core::fragment::picking_old::concepts::Library< VallSections >
VallSectionsconst & books () const
 return the books in this library More...
 
VallSections & books ()
 return the books in this library More...
 

Detailed Description

Vall fragment library.

Member Typedef Documentation

typedef for Library concept

typedef for Library concept

Member Function Documentation

void core::fragment::picking_old::vall::VallLibrary::add_section ( VallSection const &  section)
inline
VallSection const& core::fragment::picking_old::vall::VallLibrary::last_section ( ) const
inline

access the last section in thie library

References sections().

VallSection& core::fragment::picking_old::vall::VallLibrary::last_section ( )
inline

access the last section in thie library

References sections().

Size core::fragment::picking_old::vall::VallLibrary::n_residues ( ) const
inline
VallSection const& core::fragment::picking_old::vall::VallLibrary::operator[] ( Size  idx) const
inline

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

References sections().

void core::fragment::picking_old::vall::VallLibrary::reindex_sections ( )
inline
void core::fragment::picking_old::vall::VallLibrary::reserve ( Size  n)
inline

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

References sections().

Referenced by core::fragment::picking_old::vall::vall_library_from_file().

VallSections const& core::fragment::picking_old::vall::VallLibrary::sections ( ) const
inlineprivate
VallSections& core::fragment::picking_old::vall::VallLibrary::sections ( )
inlineprivate
void core::fragment::picking_old::vall::VallLibrary::tighten_memory ( bool const  sections_only = true)
inline

tighten memory usage

Parameters
sections_onlyif true, only tightens memory per-section and skips the operation for the whole library

Shrinks the capacity of the library by calling VallSection::tighten_memory() for each section. If 'sections_only' is false, will additionally perform a swap of the library, effectively requiring a similar amount of memory as the current library object.

Warning
The Vall libraries can be very large, so set 'sections_only' false only if you won't be running on a constrained memory platform.

References core::fragment::picking_old::concepts::Library< VallSections >::begin(), core::fragment::picking_old::concepts::Library< VallSections >::end(), and sections().

Referenced by core::fragment::picking_old::vall::vall_library_from_file().


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