DoubleCircularBuffer (dataset 8.1.4 API)

java.lang.Object
- de.gsi.dataset.utils.DoubleCircularBuffer

```
public class DoubleCircularBuffer
extends Object
```
simple circular ring buffer implementation for double type (with read == write position)

Author:

rstein

Constructor Summary

Constructors
Constructor and Description

DoubleCircularBuffer(double[] initalElements, int capacity)

DoubleCircularBuffer(int capacity)

Constructors
Constructor and Description
`DoubleCircularBuffer(double[] initalElements, int capacity)`
`DoubleCircularBuffer(int capacity)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`available()`
`int`	`capacity()`
`double[]`	`elements()`
`double`	`get()`
`double[]`	`get(double[] into, int length)`
`double[]`	`get(double[] into, int readPos, int length)`
`double`	`get(int readPos)`
`protected int`	`getIndex(int readPos)`
`boolean`	`isBufferFlipped()`
`boolean`	`put(double element)` add new element
`int`	`put(double[] newElements, int length)` add multiple new elements
`int`	`put(double[] newElements, int startIndex, int length)` add multiple new elements
`int`	`remainingCapacity()`
`double`	`replace(double element)`
`double`	`replace(double element, int atIndex)`
`void`	`reset()` resets and clears buffer
`int`	`writePosition()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DoubleCircularBuffer
```
public DoubleCircularBuffer(double[] initalElements,
                            int capacity)
```
    Parameters:
    
    initalElements - adds element the buffer should be initialised with
    
    capacity - maximum capacity of the buffer
  - DoubleCircularBuffer
```
public DoubleCircularBuffer(int capacity)
```
    Parameters:
    
    capacity - maximum capacity of buffer
- Method Detail
  - available
```
public int available()
```
    Returns:
    
    number of available buffer elements
  - capacity
```
public int capacity()
```
    Returns:
    
    the maximum possible/filled number of available buffer elements
  - elements
```
public double[] elements()
```
    Returns:
    
    internal field array N.B. this is the raw internal double pointer do not use this unless you know what you are doing
  - get
```
public double get()
```
    Returns:
    
    value at head
  - get
```
public double[] get(double[] into,
                    int length)
```
    Parameters:
    
    into - storage container
    
    length - number of elements to be read
    
    Returns:
    
    either into or newly allocated array containing the result
  - get
```
public double[] get(double[] into,
                    int readPos,
                    int length)
```
    Parameters:
    
    into - storage container
    
    readPos - circular index (wraps around)
    
    length - number of elements to be read
    
    Returns:
    
    either into or newly allocated array containing the result
  - get
```
public double get(int readPos)
```
    Parameters:
    
    readPos - circular index (wraps around)
    
    Returns:
    
    the value
  - getIndex
```
protected int getIndex(int readPos)
```
  - isBufferFlipped
```
public boolean isBufferFlipped()
```
    Returns:
    
    whether write position exceeded at least once the capacity
  - put
```
public boolean put(double element)
```
    add new element
    
    Parameters:
    
    element - new element
    
    Returns:
    
    true
  - put
```
public int put(double[] newElements,
               int length)
```
    add multiple new elements
    
    Parameters:
    
    newElements - array of new elements
    
    length - number of elements that are to be written from array
    
    Returns:
    
    true: write index is smaller than read index
  - put
```
public int put(double[] newElements,
               int startIndex,
               int length)
```
    add multiple new elements
    
    Parameters:
    
    newElements - array of new elements
    
    startIndex - 'null'
    
    length - number of elements that are to be written from array
    
    Returns:
    
    true: write index is smaller than read index
  - remainingCapacity
```
public int remainingCapacity()
```
    Returns:
    
    number of elements that can be written before buffer wraps-around
  - replace
```
public double replace(double element)
```
    Parameters:
    
    element - to replace an existing element at the head buffer position
    
    Returns:
    
    the previous element stored at that location
  - replace
```
public double replace(double element,
                      int atIndex)
```
    Parameters:
    
    element - to replace an existing element at given buffer position
    
    atIndex - index at which to replace the value
    
    Returns:
    
    the previous element stored at that location
  - reset
```
public void reset()
```
    resets and clears buffer
  - writePosition
```
public int writePosition()
```
    Returns:
    
    internal write position

Class DoubleCircularBuffer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DoubleCircularBuffer

DoubleCircularBuffer

Method Detail

available

capacity

elements

get

get

get

get

getIndex

isBufferFlipped

put

put

put

remainingCapacity

replace

replace

reset

writePosition