Structural Bioinformatics Library
Template C++ / Python API for developping structural bioinformatics applications.
Weighted_atom_iterator< Model, Weighted_atom, Weight_functor > Class Template Reference

#include <weighted_atom_iterator.h>

Public Member Functions

template<class Functor_parameters >
 Weighted_atom_iterator (typename Model::Atoms_const_iterator it, Functor_parameters params)
 

Detailed Description

template<class Model, class Weighted_atom, class Weight_functor>
class ESBTL::Weighted_atom_iterator< Model, Weighted_atom, Weight_functor >

Class providing an iterator over atoms of a model that returns a weighted point when dereferencing. This is particularly useful when using CGAL and its algorithms working on weighted points.

Template Parameters
Modelis the type of model used.
Weighted_atomis the weighted point type returned.
Weight_functoris a function object which operator() associate a radius to an atom (as Weight_of_atoms for example.)

An alternative to this class is to use the class boost::transform_iterator, provided your function object does not need only information available at compile time.

Constructor & Destructor Documentation

◆ Weighted_atom_iterator()

Weighted_atom_iterator ( typename Model::Atoms_const_iterator  it,
Functor_parameters  params 
)
inline

Constructor.

Template Parameters
Functor_parametersis a parameter type for the function object constructor.
Parameters
itis the corresponding atom iterator.
paramsis a parameter given to the function object constructor.