mirror of
https://github.com/boostorg/multiprecision.git
synced 2026-01-19 04:22:11 +00:00
55bf069621
* Update Jamfile.v2 * Update introduction.qbk * Update tutorial.qbk * Update tutorial_cpp_int.qbk * Update tutorial_gmp_int.qbk * Update tutorial_tommath.qbk * Update integer_examples.cpp * Update tutorial_cpp_bin_float.qbk * Update tutorial_cpp_dec_float.qbk * Update tutorial_gmp_float.qbk * Update tutorial_mpfr_float.qbk * Update tutorial_float128.qbk * Update tutorial_float_builtin_ctor.qbk * Update big_seventh.cpp * Update tutorial_float_eg.qbk * Update floating_point_examples.cpp * Update mpfr_precision.cpp * Update gauss_laguerre_quadrature.cpp * Update tutorial_interval_mpfi.qbk * Update tutorial_cpp_complex.qbk * Update tutorial_mpc_complex.qbk * Update tutorial_float128_complex.qbk * Update tutorial_complex_adaptor.qbk * Update tutorial_rational.qbk * Update tutorial_tommath_rational.qbk * Update tutorial_logged_adaptor.qbk * Update tutorial_debug_adaptor.qbk * Update tutorial_visualizers.qbk * Update tutorial_fwd.qbk * Update tutorial_conversions.qbk * Update tutorial_random.qbk * Update random_snips.cpp * Update tutorial_constexpr.qbk * Update tutorial_import_export.qbk * Update cpp_int_import_export.cpp * Update tutorial_mixed_precision.qbk * Update tutorial_variable_precision.qbk * Update scoped_precision_example.cpp * Update tutorial_numeric_limits.qbk * Update tutorial_numeric_limits.qbk * Update numeric_limits_snips.cpp * Update numeric_limits_snips.cpp * Update tutorial_numeric_limits.qbk * Update numeric_limits_snips.cpp * Update numeric_limits_snips.cpp * Update tutorial_io.qbk * Update reference_number.qbk * Update reference_cpp_bin_float.qbk * Update reference_cpp_double_fp_backend.qbk * Update reference_internal_support.qbk * Update reference_backend_requirements.qbk * Update performance.qbk * Update performance_overhead.qbk * Update performance_real_world.qbk * Update performance_integer_real_world.qbk * Update performance_rational_real_world.qbk * Update reference_number.qbk * Update tutorial_numeric_limits.qbk * Update reference_backend_requirements.qbk
45 lines
1.8 KiB
Plaintext
45 lines
1.8 KiB
Plaintext
[/
|
|
Copyright 2011 - 2020 John Maddock.
|
|
Copyright 2013 - 2019 Paul A. Bristow.
|
|
Copyright 2013 Christopher Kormanyos.
|
|
|
|
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).
|
|
]
|
|
|
|
[section:tom_int tom_int]
|
|
|
|
`#include <boost/multiprecision/tommath.hpp>`
|
|
|
|
namespace boost{ namespace multiprecision{
|
|
|
|
class tommath_int;
|
|
|
|
typedef number<tommath_int > tom_int;
|
|
|
|
}} // namespaces
|
|
|
|
The `tommath_int` back-end is used via the typedef `boost::multiprecision::tom_int`. It acts as a thin wrapper around the [tommath] `tom_int`
|
|
to provide an integer type that is a drop-in replacement for the native C++ integer types, but with unlimited precision.
|
|
|
|
Things you should know when using this type:
|
|
|
|
* Default constructed objects have the value zero (this is [tommath]'s default behavior).
|
|
* Although `tom_int` is mostly a drop in replacement for the integer __fundamental_types, it should be noted that it is a
|
|
rather strange beast as it's a signed type that is not a 2's complement type. As a result the bitwise operations
|
|
`| & ^` will throw a `std::runtime_error` exception if either of the arguments is negative. Similarly the complement
|
|
operator`~` is deliberately not implemented for this type.
|
|
* Formatted IO for this type does not support octal or hexadecimal notation for negative values,
|
|
as a result performing formatted output on this type when the argument is negative and either of the flags
|
|
`std::ios_base::oct` and `std::ios_base::hex` is set will result in a `std::runtime_error` being thrown.
|
|
* Conversion from a string results in a `std::runtime_error` being thrown if the string can not be interpreted
|
|
as a valid integer.
|
|
* Division by zero results in a `std::overflow_error` being thrown.
|
|
|
|
[h5 Example:]
|
|
|
|
[tommath_eg]
|
|
|
|
[endsect] [/section:tom_int tom_int]
|