Chemical Data Processing Library C++ API - Version 1.1.1
Public Member Functions | List of all members
CDPL::Chem::HashCodeCalculator::DefAtomHashSeedFunctor Class Reference

The default functor for the generation of atom hash seeds. More...

#include <HashCodeCalculator.hpp>

Public Member Functions

 DefAtomHashSeedFunctor (const HashCodeCalculator &calculator, unsigned int flags=DEF_ATOM_PROPERTY_FLAGS)
 Constructs the atom hash seed functor object for the specified set of atomic properties. More...
 
std::uint64_t operator() (const Atom &atom) const
 Generates an initial hash code value (seed) for the specified atom. More...
 

Detailed Description

The default functor for the generation of atom hash seeds.

Constructor & Destructor Documentation

◆ DefAtomHashSeedFunctor()

CDPL::Chem::HashCodeCalculator::DefAtomHashSeedFunctor::DefAtomHashSeedFunctor ( const HashCodeCalculator calculator,
unsigned int  flags = DEF_ATOM_PROPERTY_FLAGS 
)
inline

Constructs the atom hash seed functor object for the specified set of atomic properties.

The flags argument is an OR combination of the constants defined in namespace Chem::AtomPropertyFlag. Supported property flags are:

Parameters
calculatorThe HashCodeCalculator instance that 'owns' the functor object.
flagsSpecifies the set of considered atomic properties.

Member Function Documentation

◆ operator()()

std::uint64_t CDPL::Chem::HashCodeCalculator::DefAtomHashSeedFunctor::operator() ( const Atom atom) const

Generates an initial hash code value (seed) for the specified atom.

The generated hash seed depends on the set of considered atomic properties that has been specified in the constructor.

Parameters
atomThe atom for which to generate the initial hash code.
Returns
The generated atom hash seed.

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