Lookup table mapping (terminal-atom-1 type, center-atom type, terminal-atom-2 type, out-of-plane-atom type) quadruples to MMFF94 out-of-plane bending force constants. More...

#include <MMFF94OutOfPlaneBendingParameterTable.hpp>

Classes
class	Entry
	A single out-of-plane bending parameter record. More...

Public Types
typedef std::shared_ptr< MMFF94OutOfPlaneBendingParameterTable >	SharedPointer
	A reference-counted smart pointer [SHPTR] for dynamically allocated `MMFF94OutOfPlaneBendingParameterTable` instances. More...

typedef boost::transform_iterator< std::function< const Entry &(const DataStorage::value_type &)>, DataStorage::const_iterator >	ConstEntryIterator
	A constant iterator over the entries of the table. More...

typedef boost::transform_iterator< std::function< Entry &(DataStorage::value_type &)>, DataStorage::iterator >	EntryIterator
	A mutable iterator over the entries of the table. More...

Public Member Functions
	MMFF94OutOfPlaneBendingParameterTable ()
	Constructs an empty `MMFF94OutOfPlaneBendingParameterTable` instance. More...

void	addEntry (unsigned int term_atom1_type, unsigned int ctr_atom_type, unsigned int term_atom2_type, unsigned int oop_atom_type, double force_const)
	Adds (or overwrites) the entry for the given (terminal-atom 1, center atom, terminal-atom 2, out-of-plane atom) quadruple. More...

const Entry &	getEntry (unsigned int term_atom1_type, unsigned int ctr_atom_type, unsigned int term_atom2_type, unsigned int oop_atom_type) const
	Returns the entry for the given (terminal-atom 1, center atom, terminal-atom 2, out-of-plane atom) quadruple. More...

std::size_t	getNumEntries () const
	Returns the number of entries in the table. More...

void	clear ()
	Removes all entries from the table. More...

bool	removeEntry (unsigned int term_atom1_type, unsigned int ctr_atom_type, unsigned int term_atom2_type, unsigned int oop_atom_type)
	Removes the entry for the given (terminal-atom 1, center atom, terminal-atom 2, out-of-plane atom) quadruple. More...

EntryIterator	removeEntry (const EntryIterator &it)
	Removes the entry pointed to by the iterator it. More...

ConstEntryIterator	getEntriesBegin () const
	Returns a constant iterator pointing to the beginning of the entry list. More...

ConstEntryIterator	getEntriesEnd () const
	Returns a constant iterator pointing one past the last entry. More...

EntryIterator	getEntriesBegin ()
	Returns a mutable iterator pointing to the beginning of the entry list. More...

EntryIterator	getEntriesEnd ()
	Returns a mutable iterator pointing one past the last entry. More...

ConstEntryIterator	begin () const
	Returns a constant iterator pointing to the beginning of the entry list (alias of getEntriesBegin()). More...

ConstEntryIterator	end () const
	Returns a constant iterator pointing one past the last entry (alias of getEntriesEnd()). More...

EntryIterator	begin ()
	Returns a mutable iterator pointing to the beginning of the entry list (alias of getEntriesBegin()). More...

EntryIterator	end ()
	Returns a mutable iterator pointing one past the last entry (alias of getEntriesEnd()). More...

void	load (std::istream &is)
	Loads table entries from the input stream is. More...

void	loadDefaults (unsigned int param_set)
	Loads the built-in default out-of-plane bending parameter entries for the specified MMFF94 parameter set. More...

Static Public Member Functions
static void	set (const SharedPointer &table, unsigned int param_set)
	Replaces the process-wide default table for param_set by table. More...

static const SharedPointer &	get (unsigned int param_set)
	Returns the process-wide default table for param_set (lazily initialized on first call). More...

Detailed Description

Lookup table mapping (terminal-atom-1 type, center-atom type, terminal-atom-2 type, out-of-plane-atom type) quadruples to MMFF94 out-of-plane bending force constants.

The table maintains separate process-wide defaults per MMFF94 parameter set (see Util::MMFF94ParameterSet).

Member Typedef Documentation

◆ SharedPointer

typedef std::shared_ptr<MMFF94OutOfPlaneBendingParameterTable> CDPL::ForceField::MMFF94OutOfPlaneBendingParameterTable::SharedPointer

A reference-counted smart pointer [SHPTR] for dynamically allocated MMFF94OutOfPlaneBendingParameterTable instances.

◆ ConstEntryIterator

typedef boost::transform_iterator<std::function<const Entry&(const DataStorage::value_type&)>, DataStorage::const_iterator> CDPL::ForceField::MMFF94OutOfPlaneBendingParameterTable::ConstEntryIterator

A constant iterator over the entries of the table.

◆ EntryIterator

typedef boost::transform_iterator<std::function<Entry&(DataStorage::value_type&)>, DataStorage::iterator> CDPL::ForceField::MMFF94OutOfPlaneBendingParameterTable::EntryIterator

A mutable iterator over the entries of the table.

Constructor & Destructor Documentation

◆ MMFF94OutOfPlaneBendingParameterTable()

CDPL::ForceField::MMFF94OutOfPlaneBendingParameterTable::MMFF94OutOfPlaneBendingParameterTable ( )

Constructs an empty MMFF94OutOfPlaneBendingParameterTable instance.

Member Function Documentation

◆ addEntry()

void CDPL::ForceField::MMFF94OutOfPlaneBendingParameterTable::addEntry	(	unsigned int	term_atom1_type,
		unsigned int	ctr_atom_type,
		unsigned int	term_atom2_type,
		unsigned int	oop_atom_type,
		double	force_const
	)

Adds (or overwrites) the entry for the given (terminal-atom 1, center atom, terminal-atom 2, out-of-plane atom) quadruple.

Parameters

term_atom1_type	The numeric MMFF94 atom type of the first terminal atom.
ctr_atom_type	The numeric MMFF94 atom type of the center atom.
term_atom2_type	The numeric MMFF94 atom type of the second terminal atom.
oop_atom_type	The numeric MMFF94 atom type of the out-of-plane atom.
force_const	The out-of-plane bending force constant.

◆ getEntry()

const Entry& CDPL::ForceField::MMFF94OutOfPlaneBendingParameterTable::getEntry	(	unsigned int	term_atom1_type,
		unsigned int	ctr_atom_type,
		unsigned int	term_atom2_type,
		unsigned int	oop_atom_type
	)		const

Returns the entry for the given (terminal-atom 1, center atom, terminal-atom 2, out-of-plane atom) quadruple.

Parameters

term_atom1_type	The numeric MMFF94 atom type of the first terminal atom.
ctr_atom_type	The numeric MMFF94 atom type of the center atom.
term_atom2_type	The numeric MMFF94 atom type of the second terminal atom.
oop_atom_type	The numeric MMFF94 atom type of the out-of-plane atom.

Returns: A const reference to the matching entry, or to an uninitialized entry (whose operator bool() returns false) if no match exists.

◆ getNumEntries()

std::size_t CDPL::ForceField::MMFF94OutOfPlaneBendingParameterTable::getNumEntries ( ) const

Returns the number of entries in the table.

Returns: The entry count.

◆ clear()

void CDPL::ForceField::MMFF94OutOfPlaneBendingParameterTable::clear ( )

Removes all entries from the table.

◆ removeEntry() [1/2]

bool CDPL::ForceField::MMFF94OutOfPlaneBendingParameterTable::removeEntry	(	unsigned int	term_atom1_type,
		unsigned int	ctr_atom_type,
		unsigned int	term_atom2_type,
		unsigned int	oop_atom_type
	)

Removes the entry for the given (terminal-atom 1, center atom, terminal-atom 2, out-of-plane atom) quadruple.

Parameters

term_atom1_type	The numeric MMFF94 atom type of the first terminal atom.
ctr_atom_type	The numeric MMFF94 atom type of the center atom.
term_atom2_type	The numeric MMFF94 atom type of the second terminal atom.
oop_atom_type	The numeric MMFF94 atom type of the out-of-plane atom.

Returns: true if a matching entry was removed, and false if no such entry existed.

◆ removeEntry() [2/2]

EntryIterator CDPL::ForceField::MMFF94OutOfPlaneBendingParameterTable::removeEntry ( const EntryIterator & it )

Removes the entry pointed to by the iterator it.

Parameters

it	An iterator pointing to the entry to remove.

Returns: An iterator pointing to the entry immediately following the removed one.

◆ getEntriesBegin() [1/2]

ConstEntryIterator CDPL::ForceField::MMFF94OutOfPlaneBendingParameterTable::getEntriesBegin ( ) const

Returns a constant iterator pointing to the beginning of the entry list.

Returns: A constant iterator to the first entry.

◆ getEntriesEnd() [1/2]

ConstEntryIterator CDPL::ForceField::MMFF94OutOfPlaneBendingParameterTable::getEntriesEnd ( ) const

Returns a constant iterator pointing one past the last entry.

Returns: A constant iterator to the end of the entry list.

◆ getEntriesBegin() [2/2]

EntryIterator CDPL::ForceField::MMFF94OutOfPlaneBendingParameterTable::getEntriesBegin ( )

Returns a mutable iterator pointing to the beginning of the entry list.

Returns: A mutable iterator to the first entry.

◆ getEntriesEnd() [2/2]

EntryIterator CDPL::ForceField::MMFF94OutOfPlaneBendingParameterTable::getEntriesEnd ( )

Returns a mutable iterator pointing one past the last entry.

Returns: A mutable iterator to the end of the entry list.

◆ begin() [1/2]

ConstEntryIterator CDPL::ForceField::MMFF94OutOfPlaneBendingParameterTable::begin ( ) const

Returns a constant iterator pointing to the beginning of the entry list (alias of getEntriesBegin()).

Returns: A constant iterator to the first entry.

◆ end() [1/2]

ConstEntryIterator CDPL::ForceField::MMFF94OutOfPlaneBendingParameterTable::end ( ) const

Returns a constant iterator pointing one past the last entry (alias of getEntriesEnd()).

Returns: A constant iterator to the end of the entry list.

◆ begin() [2/2]

EntryIterator CDPL::ForceField::MMFF94OutOfPlaneBendingParameterTable::begin ( )

Returns a mutable iterator pointing to the beginning of the entry list (alias of getEntriesBegin()).

Returns: A mutable iterator to the first entry.

◆ end() [2/2]

EntryIterator CDPL::ForceField::MMFF94OutOfPlaneBendingParameterTable::end ( )

Returns a mutable iterator pointing one past the last entry (alias of getEntriesEnd()).

Returns: A mutable iterator to the end of the entry list.

◆ load()

void CDPL::ForceField::MMFF94OutOfPlaneBendingParameterTable::load ( std::istream & is )

Loads table entries from the input stream is.

Parameters

is	The input stream to read from.

◆ loadDefaults()

void CDPL::ForceField::MMFF94OutOfPlaneBendingParameterTable::loadDefaults ( unsigned int param_set )

Loads the built-in default out-of-plane bending parameter entries for the specified MMFF94 parameter set.

Parameters

param_set The Util::MMFF94ParameterSet identifier selecting which built-in defaults to load.

◆ set()

static void CDPL::ForceField::MMFF94OutOfPlaneBendingParameterTable::set	(	const SharedPointer &	table,
		unsigned int	param_set
	)

static

Replaces the process-wide default table for param_set by table.

Parameters

table	The new default table (a `nullptr` resets to the built-in default).
param_set	The Util::MMFF94ParameterSet identifier selecting which default slot to replace.

◆ get()

static const SharedPointer& CDPL::ForceField::MMFF94OutOfPlaneBendingParameterTable::get ( unsigned int param_set )

static

Returns the process-wide default table for param_set (lazily initialized on first call).

Parameters

param_set The Util::MMFF94ParameterSet identifier selecting which default slot to return.

Returns: A const reference to the selected default-table shared pointer.

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

MMFF94OutOfPlaneBendingParameterTable.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ SharedPointer

◆ ConstEntryIterator

◆ EntryIterator

Constructor & Destructor Documentation

◆ MMFF94OutOfPlaneBendingParameterTable()

Member Function Documentation

◆ addEntry()

◆ getEntry()

◆ getNumEntries()

◆ clear()

◆ removeEntry() [1/2]

◆ removeEntry() [2/2]

◆ getEntriesBegin() [1/2]

◆ getEntriesEnd() [1/2]

◆ getEntriesBegin() [2/2]

◆ getEntriesEnd() [2/2]

◆ begin() [1/2]

◆ end() [1/2]

◆ begin() [2/2]

◆ end() [2/2]

◆ load()

◆ loadDefaults()

◆ set()

◆ get()