src/gromacs/options/valuestore.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2017,2018,2019,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 /*! \file
  36  * \brief
  37  * Declares implementations for IOptionValueStore.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_options
  41  */
  42 #ifndef GMX_OPTIONS_VALUESTORE_H
  43 #define GMX_OPTIONS_VALUESTORE_H
  44
  45 #include <vector>
  46
  47 #include "gromacs/utility/arrayref.h"
  48
  49 #include "ivaluestore.h"
  50
  51 namespace gmx
  52 {
  53
  54 template<typename T>
  55 class OptionValueStorePlain : public IOptionValueStore<T>
  56 {
  57 public:
  58     OptionValueStorePlain(T* store, int* storeCount, int initialCount) :
  59         count_(initialCount), store_(store), storeCount_(storeCount)
  60     {
  61     }
  62
  63     int         valueCount() override { return count_; }
  64     ArrayRef<T> values() override { return arrayRefFromArray(store_, count_); }
  65     void        clear() override
  66     {
  67         count_ = 0;
  68         if (storeCount_ != nullptr)
  69         {
  70             *storeCount_ = count_;
  71         }
  72     }
  73     void reserve(size_t /*count*/) override {}
  74     void append(const T& value) override
  75     {
  76         store_[count_] = value;
  77         ++count_;
  78         if (storeCount_ != nullptr)
  79         {
  80             *storeCount_ = count_;
  81         }
  82     }
  83
  84 private:
  85     int  count_;
  86     T*   store_;
  87     int* storeCount_;
  88 };
  89
  90 template<typename T>
  91 class OptionValueStoreVector : public IOptionValueStore<T>
  92 {
  93 public:
  94     explicit OptionValueStoreVector(std::vector<T>* store) : store_(store) {}
  95
  96     int         valueCount() override { return static_cast<int>(store_->size()); }
  97     ArrayRef<T> values() override { return *store_; }
  98     void        clear() override { store_->clear(); }
  99     void        reserve(size_t count) override { store_->reserve(store_->size() + count); }
 100     void        append(const T& value) override { store_->push_back(value); }
 101
 102 private:
 103     std::vector<T>* store_;
 104 };
 105
 106 // Specialization that works around std::vector<bool> specialities.
 107 template<>
 108 class OptionValueStoreVector<bool> : public IOptionValueStore<bool>
 109 {
 110 public:
 111     explicit OptionValueStoreVector(std::vector<bool>* store) : store_(store) {}
 112
 113     int            valueCount() override { return static_cast<int>(store_->size()); }
 114     ArrayRef<bool> values() override
 115     {
 116         return arrayRefFromArray(reinterpret_cast<bool*>(boolStore_.data()), boolStore_.size());
 117     }
 118     void clear() override
 119     {
 120         boolStore_.clear();
 121         store_->clear();
 122     }
 123     void reserve(size_t count) override
 124     {
 125         boolStore_.reserve(boolStore_.size() + count);
 126         store_->reserve(store_->size() + count);
 127     }
 128     void append(const bool& value) override
 129     {
 130         boolStore_.push_back({ value });
 131         store_->push_back(value);
 132     }
 133
 134 private:
 135     struct Bool
 136     {
 137         bool value;
 138     };
 139
 140     std::vector<Bool>  boolStore_;
 141     std::vector<bool>* store_;
 142 };
 143
 144 /*! \internal
 145  * \brief
 146  * Value storage that does not store anywhere.
 147  *
 148  * This is needed because even though the values are not stored anywhere, the
 149  * code still expects to access them later through valueCount() and values().
 150  *
 151  * \ingroup module_options
 152  */
 153 template<typename T>
 154 class OptionValueStoreNull : public IOptionValueStore<T>
 155 {
 156 public:
 157     OptionValueStoreNull() : store_(&vector_) {}
 158
 159     int         valueCount() override { return store_.valueCount(); }
 160     ArrayRef<T> values() override { return store_.values(); }
 161     void        clear() override { store_.clear(); }
 162     void        reserve(size_t count) override { store_.reserve(count); }
 163     void        append(const T& value) override { store_.append(value); }
 164
 165 private:
 166     std::vector<T>            vector_;
 167     OptionValueStoreVector<T> store_;
 168 };
 169
 170 } // namespace gmx
 171
 172 #endif