Use better data structure to implement ResidueType
[alexxy/gromacs.git] / src / gromacs / topology / residuetypes.h
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2010,2014,2018,2019,2020,2021, by the GROMACS development team, led by
5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6  * and including many others, as listed in the AUTHORS file in the
7  * top-level source directory and at http://www.gromacs.org.
8  *
9  * GROMACS is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public License
11  * as published by the Free Software Foundation; either version 2.1
12  * of the License, or (at your option) any later version.
13  *
14  * GROMACS is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with GROMACS; if not, see
21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
23  *
24  * If you want to redistribute modifications to GROMACS, please
25  * consider that scientific software is very special. Version
26  * control is crucial - bugs must be traceable. We will be happy to
27  * consider code for inclusion in the official distribution, but
28  * derived work must not be called official GROMACS. Details are found
29  * in the README & COPYING files - if they are missing, get the
30  * official version at http://www.gromacs.org.
31  *
32  * To help us fund GROMACS development, we humbly ask that you cite
33  * the research papers on the package. Check out http://www.gromacs.org.
34  */
35 #ifndef GMX_TOPOLOGY_RESIDUETYPES_H
36 #define GMX_TOPOLOGY_RESIDUETYPES_H
37
38 #include <memory>
39 #include <optional>
40 #include <string>
41
42 #include "gromacs/utility/basedefinitions.h"
43
44 /*! \brief Convenience type aliases
45  *
46  * These are not as useful as strong types, but they will
47  * help clarify usage to humans in some cases. */
48 //! \{
49 using ResidueName = std::string;
50 using ResidueType = std::string;
51 //! \}
52
53 class ResidueTypeMap
54 {
55 public:
56     //! Default constructor.
57     ResidueTypeMap();
58     //! Default destructor.
59     ~ResidueTypeMap();
60
61     /*! \brief
62      * Return true if residue \p residueName is found or false otherwise.
63      *
64      * \param[in] residueName Residue name to search database for.
65      * \returns true if successful.
66      */
67     bool nameIndexedInResidueTypeMap(const ResidueName& residueName);
68     /*! \brief
69      * Add entry to ResidueTypeMap if unique.
70      *
71      * \param[in] residueName Name of new residue.
72      * \param[in] residueType Type of new residue.
73      */
74     void addResidue(const ResidueName& residueName, const ResidueType& residueType);
75     /*! \brief
76      * Checks if the indicated \p residueName if of \p residueType.
77      *
78      * \param[in] residueName Residue that should be checked.
79      * \param[in] residueType Which ResidueType the residue should have.
80      * \returns If the check was successful.
81      */
82     bool namedResidueHasType(const ResidueName& residueName, const ResidueType& residueType);
83     /*! \brief
84      * Return the residue type if a residue with that name exists, or "Other"
85      *
86      * \param[in] residueName Name of the residue to search for.
87      * \returns The residue type of any matching residue, or "Other"
88      */
89     ResidueType typeOfNamedDatabaseResidue(const ResidueName& residueName);
90     /*! \brief
91      * Return an optional residue type if a residue with that name exists
92      *
93      * \param[in] residueName Name of the residue to search for.
94      * \returns An optional containing the residue type of any matching residue
95      */
96     std::optional<ResidueType> optionalTypeOfNamedDatabaseResidue(const ResidueName& residueName);
97
98 private:
99     //! Implementation pointer.
100     class Impl;
101
102     std::unique_ptr<Impl> impl_;
103 };
104
105 #endif