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_Buried_surface_area_with_labels< ParticleWithSystemLabelTraits, ParticleBSARecord, FTSelf
 
typedef T_Molecular_structure_traits< ParticleWithSystemLabelTraits > Molecular_structure_traits
 Traits clas defining types used for the Molecular Structure Classifier. More...
 
typedef Molecular_structure_traits::Partner_labels_traits Partner_labels_traits
 Model of MolecularSystemLabelsTraits for partners' labels. More...
 
typedef Partner_labels_traits::Label Partner_label
 
typedef Molecular_structure_traits::Molecular_structure Alpha_complex
 Geometric representation of a molecule where particles have a label. More...
 
typedef Alpha_complex::Alpha_complex_of_molecular_model_traits::Particle_type Particle_type
 
typedef ParticleBSARecord Particle_BSA_record
 

Constructors / Destructors

 T_Buried_surface_area_with_labels (Alpha_complex &alpha_complex)
 
 ~T_Buried_surface_area_with_labels (void)
 

Functors

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

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

Geometric representation of a molecule where particles have a label.

◆ Molecular_structure_traits

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

typedef ParticleBSARecord Particle_BSA_record

◆ Particle_type

typedef Alpha_complex::Alpha_complex_of_molecular_model_traits::Particle_type Particle_type

◆ Partner_label

◆ Partner_labels_traits

◆ Self

typedef T_Buried_surface_area_with_labels<ParticleWithSystemLabelTraits, ParticleBSARecord, FT> Self

Constructor & Destructor Documentation

◆ T_Buried_surface_area_with_labels()

T_Buried_surface_area_with_labels ( Alpha_complex alpha_complex)
inline

◆ ~T_Buried_surface_area_with_labels()

Member Function Documentation

◆ get_by_particle_list()

std::list<Particle_BSA_record>& get_by_particle_list ( )
inline

Returns the list containg BSA by particle, for serialization.

◆ operator()()

FT operator() ( Partner_label  partner) const
inline

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