Giter Site home page Giter Site logo

Comments (4)

rlogiacco avatar rlogiacco commented on July 30, 2024

Any access beyond the current buffer bounds is a violation of the contract and assuming anything about the buffer internal state is a usage error.
If the values returned for the populated buffer positions is correct then the buffer operates as intended.

In other words, accessing positions beyond 0 is an error, you are making assumptions on how the buffer operates on its internals.

It wasn't arising in the previous version because the buffer wasn't protecting its internal state properly: now the buffer does that better and it only allows you to access populated positions. If you have only one element it doesn't matter what's the index you provide, you will always get that single item.
Push in another one and you'll see the two values alternating...

from circularbuffer.

rlogiacco avatar rlogiacco commented on July 30, 2024

Another way to describe the behaviour, if you want to print the buffer contents you should only print the items between position 0 and position buffer.size() - 1: in your case between 0 and 0 after the first insertion....

See the two for-loops examples at https://github.com/rlogiacco/CircularBuffer#automatic-optimization and the code at

void printBuffer() {
if (buffer.isEmpty()) {
Serial.println("empty");
} else {
Serial.print("[");
for (decltype(buffer)::index_t i = 0; i < buffer.size() - 1; i++) {
Serial.print(buffer[i]);
Serial.print(",");
}
Serial.print(buffer[buffer.size() - 1]);
Serial.print("] (");
Serial.print(buffer.size());
Serial.print("/");
Serial.print(buffer.size() + buffer.available());
if (buffer.isFull()) {
Serial.print(" full");
}
Serial.println(")");
}
}
for reference.

If you want to inspect the internals for debugging reasons, you can enable debugging and use the two debug functions exposed by the library:

#define CIRCULAR_BUFFER_DEBUG
#include <CircularBuffer.h>
CircularBuffer<long, 6> buffer;

And then you can call buffer.debug(Serial) or buffer.debug(Serial, customFunction) to see the whole buffer contents with the head and tail positions.

from circularbuffer.

pkrssy avatar pkrssy commented on July 30, 2024

You're right but for a simple user like me it would be more comfortable to indicate the data is not available (return "nan") without the need to add additional conditions in a for cycle.

from circularbuffer.

rlogiacco avatar rlogiacco commented on July 30, 2024

from circularbuffer.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.