From ca8b904502c7c1dca6d2127f25a4dfa596c0f863 Mon Sep 17 00:00:00 2001
From: Beman
Date: Wed, 31 Dec 2014 10:32:47 -0500
Subject: [PATCH] Minor edits. Update TOC.
---
doc/index.html | 37 ++++++++++++++++++++++---------------
1 file changed, 22 insertions(+), 15 deletions(-)
diff --git a/doc/index.html b/doc/index.html
index 114c635..4914b12 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -42,15 +42,20 @@
Abstract
Introduction to endianness
Introduction to the Boost.Endian library
-Choosing between conversion, buffer types,
- and arithmetic types
+Choosing between conversion functions,
+ buffer types, and arithmetic types
Characteristics
Endianness invariants
Conversion explicitness
Arithmetic operations
Sizes
Alignments
- Use cases
+ Design patterns
+ Convert only as needed (i.e. lazy)
+ Convert in anticipation of need
+ Generally
+as needed, locally in anticipation
+ Use case examples
Porting endian unaware codebase
Porting endian aware codebase
Reliability and arithmetic-speed
@@ -83,7 +88,11 @@
endianness of integers,
floating point numbers, and user-defined types.
- - Primary use cases:
+ - Three approaches to dealing with endianness are supported. Each has a
+ long history of successful use, and each approach has use cases where it is
+ preferred over the other approaches.
+
+ - Primary uses:
- Data portability. The Endian library supports binary data exchange, via either external media or network transmission,
regardless of platform endianness.
@@ -97,14 +106,15 @@ floating point numbers, and user-defined types.
- - Secondary use case: Minimizing data size via sizes and/or alignments not supported by the
+
- Secondary use: Minimizing data size via sizes and/or alignments not supported by the
standard C++ arithmetic types.
-
- - Three approaches to dealing with endianness are supported. Each has a
- long history of successful use, and each approach has use cases where it is
- preferred over the other approaches.
+
+
+
+
+
@@ -810,17 +820,14 @@ and 16, 32, and 64-bit aligned integers.
- -
-
The endian types have been decomposed into endian buffer types
+
- The endian types have been decomposed into endian buffer types
and endian arithmetic types, as requested. The arithmetic types derive from
the buffer types.
- -
-
Headers have been renamed to endian/arithmetic.hpp
and
+
- Headers have been renamed to
endian/arithmetic.hpp
and
endian/conversion.hpp
. endian/buffers.hpp
has been
added.
Infrastructure file names were changed accordingly.
- -
-
The endian buffer and arithmetic types and endian conversion functions now support 32-bit (float)
and
+
- The endian buffer and arithmetic types and endian conversion functions now support 32-bit (
float)
and
64-bit (double)
floating point, as requested.
- The endian types now have stream inserter and extractor templates, as
requested.