FastSmallVector.hpp

Go to the documentation of this file.

// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
/*
  Copyright 2019, 2025 Equinor ASA.

  This file is part of the Open Porous Media project (OPM).

  OPM is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 2 of the License, or
  (at your option) any later version.

  OPM is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with OPM.  If not, see <http://www.gnu.org/licenses/>.

  Consult the COPYING file in the top-level source directory of this
  module for the precise wording of the license and the list of
  copyright holders.
*/
#ifndef OPM_FAST_SMALL_VECTOR_HPP
#define OPM_FAST_SMALL_VECTOR_HPP

#include <array>
#include <algorithm>
#include <cstddef>
#include <vector>

namespace Opm {

template <typename ValueType, unsigned N>
class FastSmallVector
{
public:
    FastSmallVector()
        : size_(0)
    {
        dataPtr_ = smallBuf_.data();
    }

    explicit FastSmallVector(const std::size_t numElem)
    {
        init_(numElem);
    }

    FastSmallVector(const std::size_t numElem, const ValueType value)
    {
        init_(numElem);

        std::fill_n(dataPtr_, size_, value);
    }

    FastSmallVector(const FastSmallVector& other)
        : size_(0)
    {
        dataPtr_ = smallBuf_.data();

        (*this) = other;
    }

    FastSmallVector(FastSmallVector&& other)
        : size_(0)
    {
        dataPtr_ = smallBuf_.data();

        (*this) = std::move(other);
    }

    ~FastSmallVector()
    {
    }


    FastSmallVector& operator=(FastSmallVector&& other)
    {
        size_ = other.size_;
        if (other.usingSmallBuf()) {
            smallBuf_ = std::move(other.smallBuf_);
            dataPtr_ = smallBuf_.data();
        }
        else {
            data_ = std::move(other.data_);
            dataPtr_ = data_.data();
        }

        other.dataPtr_ = nullptr;
        other.size_ = 0;

        return (*this);
    }

    FastSmallVector& operator=(const FastSmallVector& other)
    {
        size_ = other.size_;

        if (other.usingSmallBuf()) {
            smallBuf_ = other.smallBuf_;
            dataPtr_ = smallBuf_.data();
        }
        else if (dataPtr_ != other.dataPtr_) {
            data_ = other.data_;
            dataPtr_ = data_.data();
        }

        return (*this);
    }

    ValueType& operator[](std::size_t idx)
    { return dataPtr_[idx]; }

    const ValueType& operator[](std::size_t idx) const
    { return dataPtr_[idx]; }

    using size_type = typename std::vector<ValueType>::size_type;

    size_type size() const
    { return size_; }

    using Iterator = ValueType*;

    using ConstIterator = const ValueType*;

    ConstIterator begin() const
    { return dataPtr_; }

    ConstIterator end() const
    { return dataPtr_ + size_; }

    ConstIterator cbegin() const
    { return dataPtr_; }

    ConstIterator cend() const
    { return dataPtr_ + size_; }

    Iterator begin()
    { return dataPtr_; }

    Iterator end()
    { return dataPtr_ + size_; }

    size_type capacity()
    { return this->usingSmallBuf() ? N : data_.capacity(); }

    void push_back(const ValueType& value)
    {
        if (this->usingSmallBuf()) {
            if (size_ < N) {
                // Data is contained in smallBuf_
                smallBuf_[size_++] = value;
            } else if (size_ == N) {
                // Must switch from using smallBuf_ to using data_
                data_.reserve(N + 1); // Since we will push_back to it later
                data_.resize(N);      // So we can move the existing data to it
                std::move(smallBuf_.begin(), smallBuf_.end(), data_.begin());
                data_.push_back(value);
                ++size_;
                dataPtr_ = data_.data();
            }
        } else {
            // Data is contained in data_
            data_.push_back(value);
            ++size_;
            dataPtr_ = data_.data();
        }
    }

    void resize(std::size_t numElem)
    {
        if (numElem == size_) return; // nothing to do

        if (this->usingSmallBuf()) {
            if (numElem > N) {
                data_.resize(numElem);
                if (size_ > 0 && N > 0) {
                    std::copy_n(smallBuf_.begin(), size_, data_.begin());
                }
                dataPtr_ = data_.data();
            } else if (numElem < size_) {
                // when shrinking, remove the values after numElem so that the space
                // is ready to use in the potentional future resize
                for (auto ii = numElem; ii < size_; ++ii) {
                    smallBuf_[ii].~ValueType();
                }
            }
        } else {
            // when shriking to numElem < N, we do not switch back to use smallBuf_
            data_.resize(numElem);
        }
        size_ = numElem;
    }

private:
    void init_(std::size_t numElem)
    {
        size_ = numElem;

        if (size_ > N) {
            data_.resize(size_);
            dataPtr_ = data_.data();
        } else
            dataPtr_ = smallBuf_.data();
    }

    bool usingSmallBuf() const
    {
        return dataPtr_ == smallBuf_.data();
    }

    std::array<ValueType, N> smallBuf_{};
    std::vector<ValueType> data_;
    size_type size_;
    ValueType* dataPtr_;
};

} // namespace Opm

#endif // OPM_FAST_SMALL_VECTOR_HPP