Structural Bioinformatics Library
Template C++ / Python API for developping structural bioinformatics applications.
T_Buried_surface_area_with_labels< ParticleWithSystemLabelTraits, ParticleBSARecord, FT > Class Template Reference


Compute the buried surface area of two given partners More...

#include <Buried_surface_area.hpp>

Public Types

typedef T_Molecular_structure_traits< ParticleWithSystemLabelTraits > Molecular_structure_traits
 Traits clas defining types used for the Molecular Structure Classifier.
typedef Molecular_structure_traits::Partner_labels_traits Partner_labels_traits
 Model of MolecularSystemLabelsTraits for partners' labels.
typedef Molecular_structure_traits::Molecular_structure Alpha_complex
 Geometric representation of a molecule where particles have a label.
typedef ParticleBSARecord Particle_BSA_record

Functors

FT operator() (Partner_label partner) const
 Returns the buried surface area of the partner with the input label.
std::list< Particle_BSA_record > & get_by_particle_list ()
 Returns the list containg BSA by particle, for serialization.

Detailed Description

template<class ParticleWithSystemLabelTraits, class ParticleBSARecord, class FT = CGAL::Interval_nt<false>>
class SBL::CSB::T_Buried_surface_area_with_labels< ParticleWithSystemLabelTraits, ParticleBSARecord, FT >


Compute the buried surface area of two given partners

Compute the buried surface area of two given partners

Template Parameters
ParticleWithSystemLabelTraitsModel of the concept ParticleTraits where each particle has a system's label.
FTNumber type used for representing the buried surface area (default is intervals of double).

Member Typedef Documentation

◆ Alpha_complex

template<class ParticleWithSystemLabelTraits, class ParticleBSARecord, class FT = CGAL::Interval_nt<false>>
typedef Molecular_structure_traits::Molecular_structure Alpha_complex

Geometric representation of a molecule where particles have a label.

◆ Molecular_structure_traits

template<class ParticleWithSystemLabelTraits, class ParticleBSARecord, class FT = CGAL::Interval_nt<false>>
typedef T_Molecular_structure_traits<ParticleWithSystemLabelTraits> Molecular_structure_traits

Traits clas defining types used for the Molecular Structure Classifier.

Template Parameters
ParticleWithSystemLabelTraitsModel of ParticleTraits with system's labels information.
MolecularStructureGeometric model of a molecule where particles have a system's label.

◆ Particle_BSA_record

template<class ParticleWithSystemLabelTraits, class ParticleBSARecord, class FT = CGAL::Interval_nt<false>>
typedef ParticleBSARecord Particle_BSA_record

◆ Partner_labels_traits

template<class ParticleWithSystemLabelTraits, class ParticleBSARecord, class FT = CGAL::Interval_nt<false>>
typedef Molecular_structure_traits::Partner_labels_traits Partner_labels_traits

Model of MolecularSystemLabelsTraits for partners' labels.

Member Function Documentation

◆ get_by_particle_list()

template<class ParticleWithSystemLabelTraits, class ParticleBSARecord, class FT = CGAL::Interval_nt<false>>
std::list< Particle_BSA_record > & get_by_particle_list ( )
inline

Returns the list containg BSA by particle, for serialization.

◆ operator()()

template<class ParticleWithSystemLabelTraits, class ParticleBSARecord, class FT>
FT operator() ( Partner_label partner) const
inline

Returns the buried surface area of the partner with the input label.