Program Listing for File Resevoir.hpp

↰ Return to documentation for file (include/sgpl/utility/Resevoir.hpp)

#pragma once
#ifndef SGPL_UTILITY_RESEVOIR_HPP_INCLUDE
#define SGPL_UTILITY_RESEVOIR_HPP_INCLUDE

#include <array>
#include <cassert>
#include <cstddef>
#include <utility>

namespace sgpl {

template<typename T, size_t N>
class Resevoir {

  std::array<T, N> buffer_;

  size_t size_{};

public:

  T& operator[]( const size_t pos ) { return buffer_[pos]; }

  const T& operator[]( const size_t pos ) const { return buffer_[pos]; }

  bool try_acquire() {
    if ( !full() ) {
      acquire();
      return true;
    } else return false;
  }

  void acquire() { ++size_; }

  void clear() { size_ = 0; }

  size_t size() const { return size_; }

  constexpr size_t max_size() const { return N; }

  bool empty() const { return size(); }

  bool full() const { return size() == N; }

  void release_back() { --size_; }

  T& back() { assert( size() ); return operator[](size() - 1); };

  const T& back() const {
    assert( size() );
    return operator[](size() - 1);
  };

  T& front() { return buffer_.front(); };

  const T& front()  const { return buffer_.front(); };

  void release( const size_t pos ) {
    std::swap( operator[](pos), back() );
    release_back();
  }

  T* begin() { return &front(); }

  const T* begin() const { return &front(); }

  T* end() { return begin() + size(); }

  const T* end() const { return begin() + size(); }

  auto& buffer() { return buffer_; }

  const auto& buffer() const { return buffer_; }

};

} // namespace sgpl

#endif // #ifndef SGPL_UTILITY_RESEVOIR_HPP_INCLUDE