LIFOBuffer.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "Buffer.h"

namespace MooseUtils
{

template <typename T>
class LIFOBuffer : public Buffer<T>
{
public:
  LIFOBuffer();

  LIFOBuffer(const std::size_t capacity);

  virtual void erase(const std::size_t num) override;
  virtual void eraseChunk(const std::size_t chunk_size) override;

  virtual typename Buffer<T>::iterator beginChunk(const std::size_t chunk_size) override;
  virtual typename Buffer<T>::const_iterator
  beginChunk(const std::size_t chunk_size) const override;
  virtual typename Buffer<T>::iterator endChunk(const std::size_t chunk_size) override;
  virtual typename Buffer<T>::const_iterator endChunk(const std::size_t chunk_size) const override;

protected:
  virtual std::size_t newEnd(const std::size_t new_end) override;
};

template <typename T>
LIFOBuffer<T>::LIFOBuffer() : Buffer<T>()
{
}

template <typename T>
LIFOBuffer<T>::LIFOBuffer(const std::size_t capacity) : Buffer<T>(capacity)
{
}

template <typename T>
void
LIFOBuffer<T>::erase(const std::size_t num)
{
  mooseAssert(num <= this->size(), "Cannot erase past the last entry");

  this->_end_pos -= num;

  // If there's nothing in the buffer - let's reset the positions
  if (this->_begin_pos == this->_end_pos)
    this->clear();
}

template <typename T>
void
LIFOBuffer<T>::eraseChunk(const std::size_t chunk_size)
{
  if (chunk_size > this->size())
    this->erase(this->size());
  else
    this->erase(chunk_size);
}

template <typename T>
typename Buffer<T>::iterator
LIFOBuffer<T>::beginChunk(const std::size_t chunk_size)
{
  if (chunk_size > this->size())
    return this->begin();
  else
    return this->end() - chunk_size;
}

template <typename T>
typename Buffer<T>::const_iterator
LIFOBuffer<T>::beginChunk(const std::size_t chunk_size) const
{
  if (chunk_size > this->size())
    return this->begin();
  else
    return this->end() - chunk_size;
}

template <typename T>
typename Buffer<T>::iterator
LIFOBuffer<T>::endChunk(const std::size_t /* chunk_size */)
{
  return this->end();
}

template <typename T>
typename Buffer<T>::const_iterator
LIFOBuffer<T>::endChunk(const std::size_t /* chunk_size */) const
{
  return this->end();
}

template <typename T>
std::size_t
LIFOBuffer<T>::newEnd(const std::size_t new_end)
{
  if (new_end > this->_data.size())
  {
    auto new_size = new_end - this->_begin_pos;

    this->_data.resize(std::max(new_size * 2, this->_data.size() * 2));
  }

  return new_end;
}

}