RDKit
Open-source cheminformatics and machine learning.
Loading...
Searching...
No Matches
RDKit::FingerprintArguments Class Referenceabstract

Abstract base class that holds molecule independent arguments that are common amongst all fingerprint types and classes inherited from this would hold fingerprint type specific arguments. More...

#include <FingerprintGenerator.h>

Inheritance diagram for RDKit::FingerprintArguments:
RDKit::AtomPair::AtomPairArguments RDKit::MorganFingerprint::MorganArguments RDKit::RDKitFP::RDKitFPArguments RDKit::TopologicalTorsion::TopologicalTorsionArguments

Public Member Functions

 FingerprintArguments (bool countSimulation, const std::vector< std::uint32_t > countBounds, std::uint32_t fpSize, std::uint32_t numBitsPerFeature=1, bool includeChirality=false)
 
virtual std::string infoString () const =0
 method that returns information string about the fingerprint specific argument set and the arguments themselves
 
std::string commonArgumentsString () const
 method that returns information string about common fingerprinting arguments' values
 
virtual ~FingerprintArguments ()
 

Public Attributes

bool df_countSimulation
 
bool df_includeChirality
 
std::vector< std::uint32_t > d_countBounds
 
std::uint32_t d_fpSize
 
std::uint32_t d_numBitsPerFeature
 

Detailed Description

Abstract base class that holds molecule independent arguments that are common amongst all fingerprint types and classes inherited from this would hold fingerprint type specific arguments.

Definition at line 79 of file FingerprintGenerator.h.

Constructor & Destructor Documentation

◆ FingerprintArguments()

RDKit::FingerprintArguments::FingerprintArguments ( bool countSimulation,
const std::vector< std::uint32_t > countBounds,
std::uint32_t fpSize,
std::uint32_t numBitsPerFeature = 1,
bool includeChirality = false )

◆ ~FingerprintArguments()

virtual RDKit::FingerprintArguments::~FingerprintArguments ( )
inlinevirtual

Definition at line 109 of file FingerprintGenerator.h.

Member Function Documentation

◆ commonArgumentsString()

std::string RDKit::FingerprintArguments::commonArgumentsString ( ) const

method that returns information string about common fingerprinting arguments' values

Returns
std::string information string

◆ infoString()

virtual std::string RDKit::FingerprintArguments::infoString ( ) const
pure virtual

method that returns information string about the fingerprint specific argument set and the arguments themselves

Returns
std::string information string

Implemented in RDKit::AtomPair::AtomPairArguments, RDKit::MorganFingerprint::MorganArguments, RDKit::RDKitFP::RDKitFPArguments, and RDKit::TopologicalTorsion::TopologicalTorsionArguments.

Member Data Documentation

◆ d_countBounds

std::vector<std::uint32_t> RDKit::FingerprintArguments::d_countBounds

Definition at line 89 of file FingerprintGenerator.h.

◆ d_fpSize

std::uint32_t RDKit::FingerprintArguments::d_fpSize

Definition at line 90 of file FingerprintGenerator.h.

◆ d_numBitsPerFeature

std::uint32_t RDKit::FingerprintArguments::d_numBitsPerFeature

Definition at line 91 of file FingerprintGenerator.h.

◆ df_countSimulation

bool RDKit::FingerprintArguments::df_countSimulation

Definition at line 87 of file FingerprintGenerator.h.

◆ df_includeChirality

bool RDKit::FingerprintArguments::df_includeChirality

Definition at line 88 of file FingerprintGenerator.h.


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