diff --git a/libs/endian/doc/conversion.html b/libs/endian/doc/conversion.html new file mode 100644 index 0000000..55937e9 --- /dev/null +++ b/libs/endian/doc/conversion.html @@ -0,0 +1,93 @@ + + + + + + + +Boost Endian Conversion Functions + + + + + + + + + + +
+ +boost.png (6897 bytes) + Endian Conversion Functions
+ + + + + +
Boost Home     + Endian Home     + Conversion Reference     + Types Reference     Tutorial
+ +

Introduction

+ +

 

+ +

Header <boost/endian/conversion> +Synopsis

+ +
namespace boost
+{
+namespace endian
+{
+  // unconditional modifying (i.e. in-place) endianness reversal
+
+  inline void flip(int16_t& x);
+  inline void flip(int32_t& x);
+  inline void flip(int64_t& x);
+  inline void flip(uint16_t& x);
+  inline void flip(uint32_t& x);
+  inline void flip(uint64_t& x);
+
+  // unconditional non-modifying endianness reversing copy
+
+  inline void flip(int16_t source, int16_t& target);
+  inline void flip(int32_t source, int32_t& target);
+  inline void flip(int64_t source, int64_t& target);
+  inline void flip(uint16_t source, uint16_t& target);
+  inline void flip(uint32_t source, uint32_t& target);
+  inline void flip(uint64_t source, uint64_t& target);
+
+  // conditional modifying (i.e. in-place) endianness reversal;
+  //  no effect if native endianness and specified endianness are the same
+
+  template <class T> inline void to_big(T& x);       // if different, convert native to big
+  template <class T> inline void to_little(T& x);    // if different, convert native to little
+  template <class T> inline void from_big(T& x);     // if different, convert big to native
+  template <class T> inline void from_little(T& x);  // if different, convert little to native
+
+  // non-modifying copy, conditionally reversing endianness;
+  //   copy the first argument to the second argument, converting to or from the
+  //   specified endianness if different than native endianness
+
+  template <class T> inline void to_big(T native, T& big);
+  template <class T> inline void to_little(T native, T& little);
+  template <class T> inline void from_big(T big, T& native);
+  template <class T> inline void from_little(T little, T& native);
+
+
} // namespace endian
+} // namespace boost
+

Acknowledgements

+
+

Last revised: +27 May, 2011

+

© Copyright Beman Dawes, 2011

+

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

+ +

 

+ + + + \ No newline at end of file diff --git a/libs/endian/doc/index.html b/libs/endian/doc/index.html index 8326f05..e3fd521 100644 --- a/libs/endian/doc/index.html +++ b/libs/endian/doc/index.html @@ -15,7 +15,7 @@ -boost.png (6897 bytes) +boost.png (6897 bytes) Endian Library @@ -23,8 +23,10 @@ - +
Boost Home  Conversion Reference - Types Reference TutorialBoost Home     + Endian Home     + Conversion Reference     + Types Reference     Tutorial
diff --git a/libs/endian/doc/types.html b/libs/endian/doc/types.html index d968153..bcb9ef9 100644 --- a/libs/endian/doc/types.html +++ b/libs/endian/doc/types.html @@ -25,7 +25,10 @@ - +
Boost Home  TutorialBoost Home     + Endian Home     + Conversion Reference     + Types Reference     Tutorial