# circularbuffer

**Repository Path**: guangxingli/circularbuffer

## Basic Information

- **Project Name**: circularbuffer
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-04-10
- **Last Updated**: 2024-04-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

CircularBuffer
===========

[![Actions Status](https://github.com/vinitjames/circularbuffer_CPP/workflows/Build%20and%20Test/badge.svg)](https://github.com/vinitjames/circularbuffer_CPP/actions)   [![MIT License](https://img.shields.io/github/license/vinitjames/circularbuffer?color=blue)](https://github.com/vinitjames/circularbuffer/blob/master/LICENSE)
## About
circularbuffer_CPP is a simple, general purpose STL style [circularbuffer](https://en.wikipedia.org/wiki/Circular_buffer) implementation in C++.


## Features
* STL style implementaion of Circular Buffer
* Lightweight (only single header file)
* Simple API conforming to STL container semantics.
* Random Access Iterator for easy forwad and reverse iteration and looping through elements.
* Test suites

## Installation
Run:
```
git clone https://github.com/vinitjames/circularbuffer_CPP.git
```
## Without CMAKE 
copy circular_buffer.h to your project

## With CMAKE 
To locally build and run test run the following commands 
```sh
$ mkdir build
$ cd build 
$ cmake ..
$ cmake --build .
$ ctest 
``` 
To include in project as a submodule just clone the repo in a subdirectory and use `add_subdirectory()` in the top level `CMakeLists.txt`