Classes

boost::xint::options Namespace Reference

Options for the integer_t template are stored in this namespace. More...

Classes

struct  copy_on_write
 Allows faster operations, at a price. More...
struct  fixedlength
 Make fixed-length integers. More...
struct  negative_absolute
 Creates an integer type that forces any negative number to its absolute value. More...
struct  negative_allowed
 Creates a signed integer type. More...
struct  negative_exception
 Creates an integer type that considers unsigned values invalid. More...
struct  negative_modulus
 Make a fixedlength integer wrap like a built-in unsigned type. More...
struct  negative_not_allowed
 Creates an unsigned integer with the most common negative-value handling. More...
struct  negative_zero
 Creates an integer type that forces any negative number to zero. More...
struct  nothrow
 Disables exceptions from the library. More...
struct  secure
 Zeros memory before deallocating. More...
struct  threadsafe
 Ensures that the integer_t objects can be safely used by multiple threads. More...

Detailed Description

Options for the integer_t template are stored in this namespace.

Thanks to the magic of Boost.Parameter, you can use as few or as many options as you need, and in any order.

There are several options for an unsigned type, which not only tell the library to make the type unsigned, but also what to do if a calculation would result in a negative number. You can only use one of them in a specific integer_t. If none of them are specified, the default is a signed type.

In addition to these options, you can also specify an allocator, which is just passed to the integer_t template directly. If specified, it must be for the boost::xint::detail::digit_t type. Defaults to std::allocator<digit_t>, the standard allocator provided by the STL.


© Copyright Chad Nelson, 2010-2011. Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)