RDKit
Open-source cheminformatics and machine learning.
Loading...
Searching...
No Matches
RDKit::TopologicalTorsion::TopologicalTorsionAtomEnv< OutputType > Class Template Reference

#include <MACCSGenerator.h>

Inheritance diagram for RDKit::TopologicalTorsion::TopologicalTorsionAtomEnv< OutputType >:
RDKit::AtomEnvironment< OutputType > RDKit::AtomEnvironment< OutputType >

Public Member Functions

OutputType getBitId (FingerprintArguments< OutputType > *arguments, const std::vector< std::uint32_t > *atomInvariants, const std::vector< std::uint32_t > *bondInvariants, const AdditionalOutput *additionalOutput, const bool hashResults=false, const std::uint64_t fpSize=0) const override
 
 TopologicalTorsionAtomEnv (OutputType bitId, INT_VECT atomPath)
 Construct a new Topological Torsion Atom Env object.
 
OutputType getBitId (FingerprintArguments *arguments, const std::vector< std::uint32_t > *atomInvariants, const std::vector< std::uint32_t > *bondInvariants, AdditionalOutput *additionalOutput, const bool hashResults=false, const std::uint64_t fpSize=0) const override
 calculates and returns the bit id to be set for this atom-environment
 
void updateAdditionalOutput (AdditionalOutput *output, size_t bitId) const override
 
 TopologicalTorsionAtomEnv (OutputType bitId, INT_VECT atomPath)
 Construct a new Topological Torsion Atom Env object.
 
- Public Member Functions inherited from RDKit::AtomEnvironment< OutputType >
virtual ~AtomEnvironment ()
 

Detailed Description

template<typename OutputType>
class RDKit::TopologicalTorsion::TopologicalTorsionAtomEnv< OutputType >

Definition at line 52 of file MACCSGenerator.h.

Constructor & Destructor Documentation

◆ TopologicalTorsionAtomEnv() [1/2]

template<typename OutputType >
RDKit::TopologicalTorsion::TopologicalTorsionAtomEnv< OutputType >::TopologicalTorsionAtomEnv ( OutputType  bitId,
INT_VECT  atomPath 
)
inline

Construct a new Topological Torsion Atom Env object.

Parameters
bitIdbitId generated for this environment

Definition at line 69 of file MACCSGenerator.h.

◆ TopologicalTorsionAtomEnv() [2/2]

template<typename OutputType >
RDKit::TopologicalTorsion::TopologicalTorsionAtomEnv< OutputType >::TopologicalTorsionAtomEnv ( OutputType  bitId,
INT_VECT  atomPath 
)
inline

Construct a new Topological Torsion Atom Env object.

Parameters
bitIdbitId generated for this environment

Definition at line 70 of file TopologicalTorsionGenerator.h.

Member Function Documentation

◆ getBitId() [1/2]

template<typename OutputType >
OutputType RDKit::TopologicalTorsion::TopologicalTorsionAtomEnv< OutputType >::getBitId ( FingerprintArguments arguments,
const std::vector< std::uint32_t > *  atomInvariants,
const std::vector< std::uint32_t > *  bondInvariants,
AdditionalOutput AdditionalOutput,
const bool  hashResults = false,
const std::uint64_t  fpSize = 0 
) const
overridevirtual

calculates and returns the bit id to be set for this atom-environment

Parameters
argumentsFingerprinting type specific molecule independent arguments
atomInvariantsAtom-invariants to be used during hashing
bondInvariantsBond-invariants to be used during hashing
hashResultsif set results will be ready to be modded
Returns
OutputType calculated bit id for this environment

Implements RDKit::AtomEnvironment< OutputType >.

◆ getBitId() [2/2]

template<typename OutputType >
OutputType RDKit::TopologicalTorsion::TopologicalTorsionAtomEnv< OutputType >::getBitId ( FingerprintArguments< OutputType > *  arguments,
const std::vector< std::uint32_t > *  atomInvariants,
const std::vector< std::uint32_t > *  bondInvariants,
const AdditionalOutput additionalOutput,
const bool  hashResults = false,
const std::uint64_t  fpSize = 0 
) const
override

◆ updateAdditionalOutput()

template<typename OutputType >
void RDKit::TopologicalTorsion::TopologicalTorsionAtomEnv< OutputType >::updateAdditionalOutput ( AdditionalOutput output,
size_t  bitId 
) const
overridevirtual

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