Structural Bioinformatics Library
Template C++ / Python API for developping structural bioinformatics applications.
T_Index_wrapper< IndexType, PrintedIndexType > Class Template Reference

Wrapper for indices where the IO dumping may be different from the index itself. More...

#include <Index_wrapper.hpp>

Public Types

typedef T_Index_wrapper< IndexType, PrintedIndexType > Self
 
typedef IndexType Index_type
 
typedef PrintedIndexType Printed_index_type
 

Constructors

 T_Index_wrapper (void)
 
 T_Index_wrapper (const Self &other)
 
 T_Index_wrapper (const Index_type &index)
 
Selfoperator= (const Index_type &index)
 

Accessors

const Index_typeindex (void) const
 
Index_typeindex (void)
 
Printed_index_type printed_index (void) const
 
static Index_type to_index (const Printed_index_type &i)
 
static Printed_index_type to_printed_index (const Index_type &i)
 
static bool & is_starting_at_1 (void)
 

I/O

template<class Archive >
void save (Archive &ar, const unsigned BOOST_PFTO int version) const
 
template<class Archive >
void load (Archive &ar, const unsigned BOOST_PFTO int version)
 

Detailed Description

template<class IndexType = std::size_t, class PrintedIndexType = std::size_t>
class SBL::IO::T_Index_wrapper< IndexType, PrintedIndexType >

Wrapper for indices where the IO dumping may be different from the index itself.

Wrapper for indices where the IO dumping may be different from the index itself

Template Parameters
IndexTypetype of the index (long unsigned by default).
PrintedIndexTypetype of the printed index (long unsigned by default).

Member Typedef Documentation

◆ Index_type

typedef IndexType Index_type

◆ Printed_index_type

typedef PrintedIndexType Printed_index_type

◆ Self

typedef T_Index_wrapper<IndexType, PrintedIndexType> Self

Constructor & Destructor Documentation

◆ T_Index_wrapper() [1/3]

T_Index_wrapper ( void  )
inline

◆ T_Index_wrapper() [2/3]

T_Index_wrapper ( const Self other)
inline

◆ T_Index_wrapper() [3/3]

T_Index_wrapper ( const Index_type index)
inline

Member Function Documentation

◆ index() [1/2]

T_Index_wrapper< IndexType, PrintedIndexType >::Index_type & index ( void  )
inline

◆ index() [2/2]

const T_Index_wrapper< IndexType, PrintedIndexType >::Index_type & index ( void  ) const
inline

◆ is_starting_at_1()

bool & is_starting_at_1 ( void  )
inlinestatic

◆ load()

void load ( Archive &  ar,
const unsigned BOOST_PFTO int  version 
)
inline

◆ operator=()

T_Index_wrapper< IndexType, PrintedIndexType > & operator= ( const Index_type index)
inline

◆ printed_index()

T_Index_wrapper< IndexType, PrintedIndexType >::Printed_index_type printed_index ( void  ) const
inline

◆ save()

void save ( Archive &  ar,
const unsigned BOOST_PFTO int  version 
) const
inline

◆ to_index()

IndexType to_index ( const Printed_index_type i)
inlinestatic

◆ to_printed_index()

PrintedIndexType to_printed_index ( const Index_type i)
inlinestatic