From b6c9150aeaf6e82aa6479649a4f3ecb1a72d28ef Mon Sep 17 00:00:00 2001 From: Beman Date: Fri, 5 Dec 2014 09:03:17 -0500 Subject: [PATCH] Doc tweeks. --- doc/buffers.html | 4 ++-- doc/mini_review_topics.html | 17 ++++++++++------- 2 files changed, 12 insertions(+), 9 deletions(-) diff --git a/doc/buffers.html b/doc/buffers.html index aaf7a72..e76a07c 100644 --- a/doc/buffers.html +++ b/doc/buffers.html @@ -5,7 +5,7 @@ -Endian Arithmetic Types +Endian Buffer Types @@ -678,7 +678,7 @@ differs from endian representation size. Vicente Botet and other reviewers suggested supporting floating point types.

Last revised: -20 November, 2014

+27 November, 2014

© Copyright Beman Dawes, 2006-2009, 2013

Distributed under the Boost Software License, Version 1.0. See www.boost.org/ LICENSE_1_0.txt

diff --git a/doc/mini_review_topics.html b/doc/mini_review_topics.html index 1409e76..e182842 100644 --- a/doc/mini_review_topics.html +++ b/doc/mini_review_topics.html @@ -29,7 +29,8 @@ integer/float type and endian conversion approaches to the common use case scenarios, and provide guidelines for choosing the most appropriate approach in user's applications.

-

Done. See Choosing between endian types and +

Done. See Choosing between + endian types and endian conversion functions.

Conversion functions supplying results via return should be provided.

@@ -57,9 +58,8 @@ possible to compare platform specific performance enhancements against portable base implementations, and to compare endian integer approaches against endian conversion approaches for the common use case scenarios.

-

Done. See Timings for Example 2. Also note - that the endian/test directory contains a number of additional - benchmark and speed test programs.

+

Done. See Timings for Example 2. The endian/test directory + also contains several addional benchmark and speed test programs.

Float (32-bits) and double (64-bits) should be supported. IEEE 754 is the primary use case.

@@ -71,13 +71,16 @@ the primary use case.

Support for user defined types (UDTs) is desirable, and should be provided where there would be no conflict with the other concerns.

-

Done.

+

Done. Need docs.

There is some concern that endian integer/float arithmetic operations might used inadvertently or inappropriately. The impact of adding an endian_buffer class without arithmetic operations should be investigated.

-

 

+

Done. The endian types have been decomposed into class template + endian_buffer and class template endian_arithmetic. Class + endian_buffer is a public base class for endian_arithmetic, + and can also be used by users as a stand-alone class.

Stream insertion and extraction of the endian integer/float types should be documented and included in the test coverage.

@@ -95,7 +98,7 @@ might used inadvertently or inappropriately. The impact of adding an endian_buff

Last revised: -12 November, 2014

+27 November, 2014

© Copyright Beman Dawes, 2014

Distributed under the Boost Software License, Version 1.0. See www.boost.org/ LICENSE_1_0.txt