Loading [MathJax]/extensions/tex2jax.js
Chemical Data Processing Library C++ API - Version 1.3.0
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | List of all members
CDPL::Descr::BulkSimilarityCalculator< DT, SVT > Class Template Reference

#include <BulkSimilarityCalculator.hpp>

Public Types

typedef DT Descriptor
 
typedef std::shared_ptr< DT > DescriptorPointer
 
typedef SVT SimilarityValue
 
typedef std::function< SVT(const DT &, const DT &)> SimilarityFunction
 
typedef std::pair< std::size_t, SVT > Result
 
typedef std::shared_ptr< BulkSimilarityCalculatorSharedPointer
 
typedef boost::indirect_iterator< typename DescriptorList::const_iterator, DT > ConstDescriptorIterator
 
typedef boost::indirect_iterator< typename DescriptorList::iterator, DT > DescriptorIterator
 
typedef ResultList::const_iterator ConstResultIterator
 

Public Member Functions

 BulkSimilarityCalculator ()=default
 
 BulkSimilarityCalculator (const BulkSimilarityCalculator &calc)=default
 
 BulkSimilarityCalculator (BulkSimilarityCalculator &&calc)=default
 
template<typename SF >
 BulkSimilarityCalculator (SF &&sim_func)
 
BulkSimilarityCalculatoroperator= (const BulkSimilarityCalculator &calc)=default
 
BulkSimilarityCalculatoroperator= (BulkSimilarityCalculator &&calc)=default
 
const SimilarityFunctiongetSimilarityFunction () const
 
template<typename SF >
void setSimilarityFunction (SF &&func)
 
void clear ()
 
DescriptorIterator getDescriptorsBegin ()
 
DescriptorIterator getDescriptorsEnd ()
 
ConstDescriptorIterator getDescriptorsBegin () const
 
ConstDescriptorIterator getDescriptorsEnd () const
 
std::size_t getNumDescriptors () const
 
void addDescriptor (const Descriptor &descr)
 
void addDescriptor (const DescriptorPointer &descr_ptr)
 
bool containsDescriptor (const Descriptor &descr) const
 
const DescriptorgetDescriptor (std::size_t idx) const
 
void removeDescriptor (std::size_t idx)
 
DescriptorIterator removeDescriptor (const DescriptorIterator &it)
 
void calculate (const Descriptor &descr, bool sort=false, bool sort_desc=true)
 
ConstResultIterator getResultsBegin () const
 
ConstResultIterator getResultsEnd () const
 
ConstResultIterator begin () const
 
ConstResultIterator end () const
 
const ResultgetResult (std::size_t idx) const
 
const SimilarityValuegetSimilarity (std::size_t idx) const
 
std::size_t getDescriptorIndex (std::size_t idx) const
 

Member Typedef Documentation

◆ Descriptor

template<typename DT = Util::BitSet, typename SVT = double>
typedef DT CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::Descriptor

◆ DescriptorPointer

template<typename DT = Util::BitSet, typename SVT = double>
typedef std::shared_ptr<DT> CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::DescriptorPointer

◆ SimilarityValue

template<typename DT = Util::BitSet, typename SVT = double>
typedef SVT CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::SimilarityValue

◆ SimilarityFunction

template<typename DT = Util::BitSet, typename SVT = double>
typedef std::function<SVT(const DT&, const DT&)> CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::SimilarityFunction

◆ Result

template<typename DT = Util::BitSet, typename SVT = double>
typedef std::pair<std::size_t, SVT> CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::Result

◆ SharedPointer

template<typename DT = Util::BitSet, typename SVT = double>
typedef std::shared_ptr<BulkSimilarityCalculator> CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::SharedPointer

◆ ConstDescriptorIterator

template<typename DT = Util::BitSet, typename SVT = double>
typedef boost::indirect_iterator<typename DescriptorList::const_iterator, DT> CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::ConstDescriptorIterator

◆ DescriptorIterator

template<typename DT = Util::BitSet, typename SVT = double>
typedef boost::indirect_iterator<typename DescriptorList::iterator, DT> CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::DescriptorIterator

◆ ConstResultIterator

template<typename DT = Util::BitSet, typename SVT = double>
typedef ResultList::const_iterator CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::ConstResultIterator

Constructor & Destructor Documentation

◆ BulkSimilarityCalculator() [1/4]

template<typename DT = Util::BitSet, typename SVT = double>
CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::BulkSimilarityCalculator ( )
default

◆ BulkSimilarityCalculator() [2/4]

template<typename DT = Util::BitSet, typename SVT = double>
CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::BulkSimilarityCalculator ( const BulkSimilarityCalculator< DT, SVT > &  calc)
default

◆ BulkSimilarityCalculator() [3/4]

template<typename DT = Util::BitSet, typename SVT = double>
CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::BulkSimilarityCalculator ( BulkSimilarityCalculator< DT, SVT > &&  calc)
default

◆ BulkSimilarityCalculator() [4/4]

template<typename DT = Util::BitSet, typename SVT = double>
template<typename SF >
CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::BulkSimilarityCalculator ( SF &&  sim_func)
inline

Member Function Documentation

◆ operator=() [1/2]

template<typename DT = Util::BitSet, typename SVT = double>
BulkSimilarityCalculator& CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::operator= ( const BulkSimilarityCalculator< DT, SVT > &  calc)
default

◆ operator=() [2/2]

template<typename DT = Util::BitSet, typename SVT = double>
BulkSimilarityCalculator& CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::operator= ( BulkSimilarityCalculator< DT, SVT > &&  calc)
default

◆ getSimilarityFunction()

template<typename DT , typename SVT >
const CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::SimilarityFunction & CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::getSimilarityFunction

◆ setSimilarityFunction()

template<typename DT , typename SVT >
template<typename SF >
void CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::setSimilarityFunction ( SF &&  func)

◆ clear()

template<typename DT , typename SVT >
void CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::clear

◆ getDescriptorsBegin() [1/2]

template<typename DT , typename SVT >
CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::DescriptorIterator CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::getDescriptorsBegin

◆ getDescriptorsEnd() [1/2]

template<typename DT , typename SVT >
CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::DescriptorIterator CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::getDescriptorsEnd

◆ getDescriptorsBegin() [2/2]

template<typename DT , typename SVT >
CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::ConstDescriptorIterator CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::getDescriptorsBegin

◆ getDescriptorsEnd() [2/2]

template<typename DT , typename SVT >
CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::ConstDescriptorIterator CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::getDescriptorsEnd

◆ getNumDescriptors()

template<typename DT , typename SVT >
std::size_t CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::getNumDescriptors

◆ addDescriptor() [1/2]

template<typename DT , typename SVT >
void CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::addDescriptor ( const Descriptor descr)

◆ addDescriptor() [2/2]

template<typename DT , typename SVT >
void CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::addDescriptor ( const DescriptorPointer descr_ptr)

◆ containsDescriptor()

template<typename DT , typename SVT >
bool CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::containsDescriptor ( const Descriptor descr) const

◆ getDescriptor()

template<typename DT , typename SVT >
const CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::Descriptor & CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::getDescriptor ( std::size_t  idx) const

◆ removeDescriptor() [1/2]

template<typename DT , typename SVT >
void CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::removeDescriptor ( std::size_t  idx)

◆ removeDescriptor() [2/2]

template<typename DT , typename SVT >
CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::DescriptorIterator CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::removeDescriptor ( const DescriptorIterator it)

◆ calculate()

template<typename DT , typename SVT >
void CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::calculate ( const Descriptor descr,
bool  sort = false,
bool  sort_desc = true 
)

◆ getResultsBegin()

template<typename DT , typename SVT >
CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::ConstResultIterator CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::getResultsBegin

◆ getResultsEnd()

template<typename DT , typename SVT >
CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::ConstResultIterator CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::getResultsEnd

◆ begin()

template<typename DT , typename SVT >
CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::ConstResultIterator CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::begin

◆ end()

template<typename DT , typename SVT >
CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::ConstResultIterator CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::end

◆ getResult()

template<typename DT , typename SVT >
const CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::Result & CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::getResult ( std::size_t  idx) const

◆ getSimilarity()

template<typename DT , typename SVT >
const CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::SimilarityValue & CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::getSimilarity ( std::size_t  idx) const

◆ getDescriptorIndex()

template<typename DT , typename SVT >
std::size_t CDPL::Descr::BulkSimilarityCalculator< DT, SVT >::getDescriptorIndex ( std::size_t  idx) const

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