Boost C++ Libraries: Ticket #4195: boost::circular_buffer documentation error

nstewart@… — Fri, 07 May 2010 15:09:43 GMT

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?

status changed; resolution set

anonymous — Wed, 19 May 2010 16:22:47 GMT

status new → closed
resolution → worksforme

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.

status changed; resolution deleted

nstewart@… — Wed, 19 May 2010 16:42:01 GMT

status closed → reopened
resolution worksforme

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))

status changed; resolution set

anonymous — Thu, 20 May 2010 03:09:42 GMT

status reopened → closed
resolution → fixed

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.