Namespaces
Variants

ckd_mul

From cppreference.net
Defined in header <stdckdint.h>
template < class type1, class type2, class type3 >
bool ckd_mul ( type1 * result, type2 a, type3 b ) ;
(since C++26)

Computes the multiplication x × y and stores the result into * result . The multiplication is performed as if both operands were represented in a signed integer type with infinite range, and the result was then converted from this integer type to type1 . If the value assigned to * result correctly represents the mathematical result of the operation, it returns false . Otherwise, it returns true . In this case, the value assigned to * result is the mathematical result of the operation wrapped around to the width of * result .

Contents

Parameters

a, b - integer values
result - address of where result should be stored

Return value

false if the value assigned to * result correctly represents the mathematical result of the multiplication, true otherwise.

Note

The function template ckd_mul has the same semantics as the corresponding type-generic macro with the same name specified in C23 .

Each of the types type1 , type2 , and type3 is a cv-unqualified signed or unsigned integer type.

It is recommended to produce a diagnostic message if type2 or type3 are not suitable integer types, or if * result is not a modifiable lvalue of a suitable integer type.

Example

References

  • C++26 standard (ISO/IEC 14882:2026):
  • 29.11.2 Checked integer operations

See also

(C++26)
checked addition operation on two integers
(function template)
(C++26)
checked subtraction operation on two integers
(function template)
C documentation for ckd_mul