CDPL::Descr::CircularFingerprintGenerator::DefBondIdentifierFunctor Class Reference

The default functor for the generation of bond identifiers. More...

#include <CircularFingerprintGenerator.hpp>

Public Member Functions
	DefBondIdentifierFunctor (unsigned int flags=DEF_BOND_PROPERTY_FLAGS)
	Constructs the bond identifier functor object for the specified set of bond properties. More...
std::uint64_t	operator() (const Chem::Bond &bond) const
	Generates an identifier for the argument bond. More...

Detailed Description

The default functor for the generation of bond identifiers.

Constructor & Destructor Documentation

DefBondIdentifierFunctor()

CDPL::Descr::CircularFingerprintGenerator::DefBondIdentifierFunctor::DefBondIdentifierFunctor ( unsigned int  flags = DEF_BOND_PROPERTY_FLAGS )

inline

Constructs the bond identifier functor object for the specified set of bond properties.

The flags argument is an OR combination of the constants defined in namespace Chem::BondPropertyFlag.

Supported property flags are:

• Chem::BondPropertyFlag::ORDER
• Chem::BondPropertyFlag::TOPOLOGY
• Chem::BondPropertyFlag::AROMATICITY

Parameters

flags

Specifies the set of considered bond properties.

Member Function Documentation

operator()()

std::uint64_t CDPL::Descr::CircularFingerprintGenerator::DefBondIdentifierFunctor::operator()

(

const Chem::Bond &

bond

)

const

Generates an identifier for the argument bond.

The generated identifier depends on the set of considered bond properties that has been specified in the constructor.

Parameters

bond	The bond for which to generate the identifier.

Returns

The generated bond identifier.

---

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

• CircularFingerprintGenerator.hpp