Chemical Data Processing Library C++ API - Version 1.4.0
GaussianShapeAlignmentStartGenerator.hpp
Go to the documentation of this file.
1 /*
2  * GaussianShapeAlignmentStartGenerator.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_SHAPE_GAUSSIANSHAPEALIGNMENTSTARTGENERATOR_HPP
30 #define CDPL_SHAPE_GAUSSIANSHAPEALIGNMENTSTARTGENERATOR_HPP
31 
32 #include <cstddef>
33 
34 #include "CDPL/Shape/APIPrefix.hpp"
36 #include "CDPL/Math/Matrix.hpp"
37 
38 
39 namespace CDPL
40 {
41 
42  namespace Shape
43  {
44 
45  class GaussianShape;
46  class GaussianShapeFunction;
47 
57  {
58 
59  public:
62 
69  virtual unsigned int setupReference(GaussianShapeFunction& func, Math::Matrix4D& xform) const;
70 
77  virtual unsigned int setupAligned(GaussianShapeFunction& func, Math::Matrix4D& xform) const;
78 
84  virtual void setReference(const GaussianShapeFunction& ref_shape_func, unsigned int sym_class) = 0;
85 
92  virtual bool generate(const GaussianShapeFunction& func, unsigned int sym_class) = 0;
93 
98  virtual std::size_t getNumStartTransforms() const = 0;
99 
108  virtual std::size_t getNumStartSubTransforms() const = 0;
109 
116  virtual const QuaternionTransformation& getStartTransform(std::size_t idx) const = 0;
117  };
118  } // namespace Shape
119 } // namespace CDPL
120 
121 #endif // CDPL_SHAPE_GAUSSIANSHAPEALIGNMENTSTARTGENERATOR_HPP
Definition of matrix data types.
Definition of the type CDPL::Shape::QuaternionTransformation.
Definition of the preprocessor macro CDPL_SHAPE_API.
#define CDPL_SHAPE_API
Tells the compiler/linker which classes, functions and variables are part of the library API.
Fixed-size vector of dimension N backed by a C-array (no dynamic allocation).
Definition: Vector.hpp:1876
Abstract base class for generators of starting transformations used to seed Gaussian-shape overlap op...
Definition: GaussianShapeAlignmentStartGenerator.hpp:57
virtual const QuaternionTransformation & getStartTransform(std::size_t idx) const =0
Returns the starting transformation at index idx.
virtual void setReference(const GaussianShapeFunction &ref_shape_func, unsigned int sym_class)=0
Specifies the reference shape function and its symmetry class.
virtual ~GaussianShapeAlignmentStartGenerator()
Virtual destructor.
Definition: GaussianShapeAlignmentStartGenerator.hpp:61
virtual unsigned int setupReference(GaussianShapeFunction &func, Math::Matrix4D &xform) const
Prepares the reference shape function for use by the start generator.
virtual std::size_t getNumStartSubTransforms() const =0
Returns the number of sub-transformations sharing the same starting transformation index space.
virtual bool generate(const GaussianShapeFunction &func, unsigned int sym_class)=0
Generates the set of starting transformations for the alignment of func.
virtual std::size_t getNumStartTransforms() const =0
Returns the number of starting transformations produced by the last generate() call.
virtual unsigned int setupAligned(GaussianShapeFunction &func, Math::Matrix4D &xform) const
Prepares the aligned shape function for use by the start generator.
Function representation of a Gaussian shape, used to evaluate the shape's density,...
Definition: GaussianShapeFunction.hpp:61
The namespace of the Chemical Data Processing Library.