Gemmi C++ API
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | List of all members
gemmi::ResidueSpan Struct Reference

#include <model.hpp>

Inheritance diagram for gemmi::ResidueSpan:
[legend]

Classes

struct  GroupingProxy
 

Public Types

using Parent = MutableVectorSpan< Residue >
 
- Public Types inherited from gemmi::MutableVectorSpan< Residue >
using vector_type = std::vector< typename Span< Residue >::value_type >
 
using iterator = typename Span< Residue >::iterator
 
- Public Types inherited from gemmi::Span< Item >
using iterator = Item *
 
using const_iterator = Item const *
 
using element_type = Item
 
using value_type = typename std::remove_cv< Item >::type
 

Public Member Functions

 ResidueSpan ()=default
 
 ResidueSpan (Parent &&span)
 
 ResidueSpan (vector_type &v, iterator begin, std::size_t n)
 
int length () const
 
SeqId::OptionalNum extreme_num (bool label, int sign) const
 
UniqProxy< Residue, ResidueSpanfirst_conformer ()
 
ConstUniqProxy< Residue, ResidueSpanfirst_conformer () const
 
GroupingProxy residue_groups ()
 
const std::string & subchain_id () const
 
ResidueGroup find_residue_group (SeqId id)
 
std::vector< std::string > extract_sequence () const
 
ConstResidueGroup find_residue_group (SeqId id) const
 
SeqId label_seq_id_to_auth (SeqId::OptionalNum label_seq_id) const
 
SeqId::OptionalNum auth_seq_id_to_label (SeqId auth_seq_id) const
 
- Public Member Functions inherited from gemmi::MutableVectorSpan< Residue >
 MutableVectorSpan ()=default
 
 MutableVectorSpan (Span< Residue > &&p, vector_type *v)
 
 MutableVectorSpan (vector_type &v, iterator begin, std::size_t n)
 
MutableVectorSpan< Residuesub (Iter first, Iter last)
 
MutableVectorSpan< Residuesubspan (F &&func)
 
MutableVectorSpan< const Residuesubspan (F &&func) const
 
iterator insert (iterator pos, Residue &&item)
 
void erase (iterator pos)
 
bool is_beginning () const
 
bool is_ending () const
 
- Public Member Functions inherited from gemmi::Span< Item >
 Span ()=default
 
 Span (iterator begin, std::size_t n)
 
template<typename T = Item>
 Span (const Span< value_type > &o, typename std::enable_if< std::is_const< T >::value >::type *=0)
 
void set_begin (iterator begin)
 
void set_size (std::size_t n)
 
const_iterator begin () const
 
const_iterator end () const
 
iterator begin ()
 
iterator end ()
 
Item & front ()
 
const Item & front () const
 
Item & back ()
 
const Item & back () const
 
const Item & operator[] (std::size_t i) const
 
Item & operator[] (std::size_t i)
 
Item & at (std::size_t i)
 
const Item & at (std::size_t i) const
 
std::size_t size () const
 
bool empty () const
 
 operator bool () const
 
template<typename Iter >
Span< Item > sub (Iter first, Iter last)
 
template<typename F , typename V = Item>
Span< Vsubspan (F &&func)
 
template<typename F >
Span< const value_typesubspan (F &&func) const
 
Spanchildren ()
 
const Spanchildren () const
 

Additional Inherited Members

- Public Attributes inherited from gemmi::Span< Item >
friend Span< const value_type >
 
friend MutableVectorSpan< value_type >
 

Detailed Description

Definition at line 371 of file model.hpp.

Member Typedef Documentation

◆ Parent

Definition at line 372 of file model.hpp.

Constructor & Destructor Documentation

◆ ResidueSpan() [1/3]

gemmi::ResidueSpan::ResidueSpan ( )
default

◆ ResidueSpan() [2/3]

gemmi::ResidueSpan::ResidueSpan ( Parent &&  span)
inline

Definition at line 375 of file model.hpp.

◆ ResidueSpan() [3/3]

gemmi::ResidueSpan::ResidueSpan ( vector_type v,
iterator  begin,
std::size_t  n 
)
inline

Definition at line 376 of file model.hpp.

Member Function Documentation

◆ length()

int gemmi::ResidueSpan::length ( ) const
inline

Definition at line 378 of file model.hpp.

◆ extreme_num()

SeqId::OptionalNum gemmi::ResidueSpan::extreme_num ( bool  label,
int  sign 
) const
inline

Definition at line 379 of file model.hpp.

◆ first_conformer() [1/2]

UniqProxy< Residue, ResidueSpan > gemmi::ResidueSpan::first_conformer ( )
inline

Definition at line 382 of file model.hpp.

◆ first_conformer() [2/2]

ConstUniqProxy< Residue, ResidueSpan > gemmi::ResidueSpan::first_conformer ( ) const
inline

Definition at line 383 of file model.hpp.

◆ residue_groups()

ResidueSpan::GroupingProxy gemmi::ResidueSpan::residue_groups ( )
inline

Definition at line 443 of file model.hpp.

◆ subchain_id()

const std::string & gemmi::ResidueSpan::subchain_id ( ) const
inline

Definition at line 385 of file model.hpp.

◆ find_residue_group() [1/2]

ResidueGroup gemmi::ResidueSpan::find_residue_group ( SeqId  id)
inline

Definition at line 422 of file model.hpp.

◆ extract_sequence()

std::vector< std::string > gemmi::ResidueSpan::extract_sequence ( ) const
inline

Definition at line 387 of file model.hpp.

◆ find_residue_group() [2/2]

ConstResidueGroup gemmi::ResidueSpan::find_residue_group ( SeqId  id) const
inline

Definition at line 425 of file model.hpp.

◆ label_seq_id_to_auth()

SeqId gemmi::ResidueSpan::label_seq_id_to_auth ( SeqId::OptionalNum  label_seq_id) const
inline

Definition at line 389 of file model.hpp.

◆ auth_seq_id_to_label()

SeqId::OptionalNum gemmi::ResidueSpan::auth_seq_id_to_label ( SeqId  auth_seq_id) const
inline

Definition at line 392 of file model.hpp.


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