boost::circular_buffer documentation error

[anonymous]

The documentation for circular_buffer::array_one() implies that the second component of the array_range type refers to the number of bytes pointed to, while in fact it is the number of entries.

[nstewart@…]

I don't see how the documentation implies bytes. In C++ it's normal for "size" to refer to the number of elements. Such as std::vector<T>::size.

Requesting clarification - can you be more specific?

[anonymous]

Replying to nstewart@…:

I don't see how the documentation implies bytes. In C++ it's normal for "size" to refer to the number of elements. Such as std::vector<T>::size.

Requesting clarification - can you be more specific?

The documentation gives the following example.

int write(int file_desc, char* buff, int num_bytes); array_range ar = buff.array_one(); write(file_desc, ar.first, ar.second); ar = buff.array_two(); write(file_desc, ar.first, ar.second);

The num_bytes implied to me that circular_buffer::array_one::second returns the number of bytes.

[nstewart@…]

Do you think this clarification would be the right solution?

write(file_desc, ar.first, ar.second)

->

write(file_desc, ar.first, ar.second*sizeof(circular_buffer<T>::value))

[anonymous]

Replying to nstewart@…:

Do you think this clarification would be the right solution?

write(file_desc, ar.first, ar.second)

->

write(file_desc, ar.first, ar.second*sizeof(circular_buffer<T>::value))

Perfect.