Chemical Data Processing Library C++ API - Version 1.4.0
AtomRDFCodeCalculator.hpp
Go to the documentation of this file.
1 /*
2  * AtomRDFCodeCalculator.hpp
3  *
4  * This file is part of the Chemical Data Processing Toolkit
5  *
6  * Copyright (C) 2003 Thomas Seidel <thomas.seidel@univie.ac.at>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this library; see the file COPYING. If not, write to
20  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
23 
29 #ifndef CDPL_DESCR_ATOMRDFCODECALCULATOR_HPP
30 #define CDPL_DESCR_ATOMRDFCODECALCULATOR_HPP
31 
32 #include "CDPL/Descr/APIPrefix.hpp"
34 #include "CDPL/Math/Vector.hpp"
35 
36 
37 namespace CDPL
38 {
39 
40  namespace Chem
41  {
42 
43  class Atom;
44  class AtomContainer;
45  } // namespace Chem
46 
47  namespace Descr
48  {
49 
62  {
63 
64  public:
69 
80 
89  void calculate(const Chem::AtomContainer& cntnr, Math::DVector& rdf_code);
90  };
91  } // namespace Descr
92 } // namespace CDPL
93 
94 #endif // CDPL_DESCR_ATOMRDFCODECALCULATOR_HPP
Definition of the preprocessor macro CDPL_DESCR_API.
#define CDPL_DESCR_API
Tells the compiler/linker which classes, functions and variables are part of the library API.
Definition of class CDPL::Descr::RDFCodeCalculator.
Definition of vector data types.
A common interface for data-structures that support a random access to stored Chem::Atom instances.
Definition: AtomContainer.hpp:55
RDFCodeCalculator implementation for the calculation of atom-centered radial distribution function (R...
Definition: AtomRDFCodeCalculator.hpp:62
void calculate(const Chem::AtomContainer &cntnr, Math::DVector &rdf_code)
Calculates the RDF code of the atoms provided by cntnr.
AtomRDFCodeCalculator()
Constructs the AtomRDFCodeCalculator instance.
AtomRDFCodeCalculator(const Chem::AtomContainer &cntnr, Math::DVector &rdf_code)
Constructs the AtomRDFCodeCalculator instance and calculates the RDF code of the atoms provided by cn...
Generic implementation of the radial distribution function (RDF) code calculation for sequences of en...
Definition: RDFCodeCalculator.hpp:61
The namespace of the Chemical Data Processing Library.