Grcov report - uint

1

macro_rules! uint_impl {

2

3

        Self = $SelfT:ty,

4

        ActualT = $ActualT:ident,

5

        SignedT = $SignedT:ident,

6

7

        // These are all for use *only* in doc comments.

8

        // As such, they're all passed as literals -- passing them as a string

9

        // literal is fine if they need to be multiple code tokens.

10

        // In non-comments, use the associated constants rather than these.

11

        BITS = $BITS:literal,

12

        BITS_MINUS_ONE = $BITS_MINUS_ONE:literal,

13

        MAX = $MaxV:literal,

14

        rot = $rot:literal,

15

        rot_op = $rot_op:literal,

16

        rot_result = $rot_result:literal,

17

        fsh_op = $fsh_op:literal,

18

        fshl_result = $fshl_result:literal,

19

        fshr_result = $fshr_result:literal,

20

        swap_op = $swap_op:literal,

21

        swapped = $swapped:literal,

22

        reversed = $reversed:literal,

23

        le_bytes = $le_bytes:literal,

24

        be_bytes = $be_bytes:literal,

25

        to_xe_bytes_doc = $to_xe_bytes_doc:expr,

26

        from_xe_bytes_doc = $from_xe_bytes_doc:expr,

27

        bound_condition = $bound_condition:literal,

28

    ) => {

29

        /// The smallest value that can be represented by this integer type.

30

///

31

        /// # Examples

32

///

33

        /// ```

34

        #[doc = concat!("assert_eq!(", stringify!($SelfT), "::MIN, 0);")]

35

        /// ```

36

        #[stable(feature = "assoc_int_consts", since = "1.43.0")]

37

        pub const MIN: Self = 0;

38

39

        /// The largest value that can be represented by this integer type

40

        #[doc = concat!("(2<sup>", $BITS, "</sup> &minus; 1", $bound_condition, ").")]

41

///

42

        /// # Examples

43

///

44

        /// ```

45

        #[doc = concat!("assert_eq!(", stringify!($SelfT), "::MAX, ", stringify!($MaxV), ");")]

46

        /// ```

47

        #[stable(feature = "assoc_int_consts", since = "1.43.0")]

48

        pub const MAX: Self = !0;

49

50

        /// The size of this integer type in bits.

51

///

52

        /// # Examples

53

///

54

        /// ```

55

        #[doc = concat!("assert_eq!(", stringify!($SelfT), "::BITS, ", stringify!($BITS), ");")]

56

        /// ```

57

        #[stable(feature = "int_bits_const", since = "1.53.0")]

58

        #[cfg(not(feature = "ferrocene_certified"))]

59

        pub const BITS: u32 = Self::MAX.count_ones();

60

61

        /// Returns the number of ones in the binary representation of `self`.

62

///

63

        /// # Examples

64

///

65

        /// ```

66

        #[doc = concat!("let n = 0b01001100", stringify!($SelfT), ";")]

67

        /// assert_eq!(n.count_ones(), 3);

68

///

69

        #[doc = concat!("let max = ", stringify!($SelfT),"::MAX;")]

70

        #[doc = concat!("assert_eq!(max.count_ones(), ", stringify!($BITS), ");")]

71

///

72

        #[doc = concat!("let zero = 0", stringify!($SelfT), ";")]

73

        /// assert_eq!(zero.count_ones(), 0);

74

        /// ```

75

        #[stable(feature = "rust1", since = "1.0.0")]

76

        #[rustc_const_stable(feature = "const_math", since = "1.32.0")]

77

        #[doc(alias = "popcount")]

78

        #[doc(alias = "popcnt")]

79

        #[must_use = "this returns the result of the operation, \

80

                      without modifying the original"]

81

        #[inline(always)]

82

13108680

        pub const fn count_ones(self) -> u32 {

83

13108680

            return intrinsics::ctpop(self);

84

13108680

85

86

        /// Returns the number of zeros in the binary representation of `self`.

87

///

88

        /// # Examples

89

///

90

        /// ```

91

        #[doc = concat!("let zero = 0", stringify!($SelfT), ";")]

92

        #[doc = concat!("assert_eq!(zero.count_zeros(), ", stringify!($BITS), ");")]

93

///

94

        #[doc = concat!("let max = ", stringify!($SelfT),"::MAX;")]

95

        /// assert_eq!(max.count_zeros(), 0);

96

        /// ```

97

        #[stable(feature = "rust1", since = "1.0.0")]

98

        #[rustc_const_stable(feature = "const_math", since = "1.32.0")]

99

        #[must_use = "this returns the result of the operation, \

100

                      without modifying the original"]

101

        #[inline(always)]

102

        #[cfg(not(feature = "ferrocene_certified"))]

103

        pub const fn count_zeros(self) -> u32 {

104

            (!self).count_ones()

105

106

107

        /// Returns the number of leading zeros in the binary representation of `self`.

108

///

109

        /// Depending on what you're doing with the value, you might also be interested in the

110

        /// [`ilog2`] function which returns a consistent number, even if the type widens.

111

///

112

        /// # Examples

113

///

114

        /// ```

115

        #[doc = concat!("let n = ", stringify!($SelfT), "::MAX >> 2;")]

116

        /// assert_eq!(n.leading_zeros(), 2);

117

///

118

        #[doc = concat!("let zero = 0", stringify!($SelfT), ";")]

119

        #[doc = concat!("assert_eq!(zero.leading_zeros(), ", stringify!($BITS), ");")]

120

///

121

        #[doc = concat!("let max = ", stringify!($SelfT),"::MAX;")]

122

        /// assert_eq!(max.leading_zeros(), 0);

123

        /// ```

124

        #[doc = concat!("[`ilog2`]: ", stringify!($SelfT), "::ilog2")]

125

        #[stable(feature = "rust1", since = "1.0.0")]

126

        #[rustc_const_stable(feature = "const_math", since = "1.32.0")]

127

        #[must_use = "this returns the result of the operation, \

128

                      without modifying the original"]

129

        #[inline(always)]

130

        #[cfg(not(feature = "ferrocene_certified"))]

131

        pub const fn leading_zeros(self) -> u32 {

132

            return intrinsics::ctlz(self as $ActualT);

133

134

135

        /// Returns the number of trailing zeros in the binary representation

136

        /// of `self`.

137

///

138

        /// # Examples

139

///

140

        /// ```

141

        #[doc = concat!("let n = 0b0101000", stringify!($SelfT), ";")]

142

        /// assert_eq!(n.trailing_zeros(), 3);

143

///

144

        #[doc = concat!("let zero = 0", stringify!($SelfT), ";")]

145

        #[doc = concat!("assert_eq!(zero.trailing_zeros(), ", stringify!($BITS), ");")]

146

///

147

        #[doc = concat!("let max = ", stringify!($SelfT),"::MAX;")]

148

        #[doc = concat!("assert_eq!(max.trailing_zeros(), 0);")]

149

        /// ```

150

        #[stable(feature = "rust1", since = "1.0.0")]

151

        #[rustc_const_stable(feature = "const_math", since = "1.32.0")]

152

        #[must_use = "this returns the result of the operation, \

153

                      without modifying the original"]

154

        #[inline(always)]

155

        #[cfg(not(feature = "ferrocene_certified"))]

156

        pub const fn trailing_zeros(self) -> u32 {

157

            return intrinsics::cttz(self);

158

159

160

        /// Returns the number of leading ones in the binary representation of `self`.

161

///

162

        /// # Examples

163

///

164

        /// ```

165

        #[doc = concat!("let n = !(", stringify!($SelfT), "::MAX >> 2);")]

166

        /// assert_eq!(n.leading_ones(), 2);

167

///

168

        #[doc = concat!("let zero = 0", stringify!($SelfT), ";")]

169

        /// assert_eq!(zero.leading_ones(), 0);

170

///

171

        #[doc = concat!("let max = ", stringify!($SelfT),"::MAX;")]

172

        #[doc = concat!("assert_eq!(max.leading_ones(), ", stringify!($BITS), ");")]

173

        /// ```

174

        #[stable(feature = "leading_trailing_ones", since = "1.46.0")]

175

        #[rustc_const_stable(feature = "leading_trailing_ones", since = "1.46.0")]

176

        #[must_use = "this returns the result of the operation, \

177

                      without modifying the original"]

178

        #[inline(always)]

179

        #[cfg(not(feature = "ferrocene_certified"))]

180

        pub const fn leading_ones(self) -> u32 {

181

            (!self).leading_zeros()

182

183

184

        /// Returns the number of trailing ones in the binary representation

185

        /// of `self`.

186

///

187

        /// # Examples

188

///

189

        /// ```

190

        #[doc = concat!("let n = 0b1010111", stringify!($SelfT), ";")]

191

        /// assert_eq!(n.trailing_ones(), 3);

192

///

193

        #[doc = concat!("let zero = 0", stringify!($SelfT), ";")]

194

        /// assert_eq!(zero.trailing_ones(), 0);

195

///

196

        #[doc = concat!("let max = ", stringify!($SelfT),"::MAX;")]

197

        #[doc = concat!("assert_eq!(max.trailing_ones(), ", stringify!($BITS), ");")]

198

        /// ```

199

        #[stable(feature = "leading_trailing_ones", since = "1.46.0")]

200

        #[rustc_const_stable(feature = "leading_trailing_ones", since = "1.46.0")]

201

        #[must_use = "this returns the result of the operation, \

202

                      without modifying the original"]

203

        #[inline(always)]

204

        #[cfg(not(feature = "ferrocene_certified"))]

205

        pub const fn trailing_ones(self) -> u32 {

206

            (!self).trailing_zeros()

207

208

209

        /// Returns the minimum number of bits required to represent `self`.

210

///

211

        /// This method returns zero if `self` is zero.

212

///

213

        /// # Examples

214

///

215

        /// ```

216

        /// #![feature(uint_bit_width)]

217

///

218

        #[doc = concat!("assert_eq!(0_", stringify!($SelfT), ".bit_width(), 0);")]

219

        #[doc = concat!("assert_eq!(0b111_", stringify!($SelfT), ".bit_width(), 3);")]

220

        #[doc = concat!("assert_eq!(0b1110_", stringify!($SelfT), ".bit_width(), 4);")]

221

        #[doc = concat!("assert_eq!(", stringify!($SelfT), "::MAX.bit_width(), ", stringify!($BITS), ");")]

222

        /// ```

223

        #[unstable(feature = "uint_bit_width", issue = "142326")]

224

        #[must_use = "this returns the result of the operation, \

225

                      without modifying the original"]

226

        #[inline(always)]

227

        #[cfg(not(feature = "ferrocene_certified"))]

228

        pub const fn bit_width(self) -> u32 {

229

            Self::BITS - self.leading_zeros()

230

231

232

        /// Returns `self` with only the most significant bit set, or `0` if

233

        /// the input is `0`.

234

///

235

        /// # Examples

236

///

237

        /// ```

238

        /// #![feature(isolate_most_least_significant_one)]

239

///

240

        #[doc = concat!("let n: ", stringify!($SelfT), " = 0b_01100100;")]

241

///

242

        /// assert_eq!(n.isolate_highest_one(), 0b_01000000);

243

        #[doc = concat!("assert_eq!(0_", stringify!($SelfT), ".isolate_highest_one(), 0);")]

244

        /// ```

245

        #[unstable(feature = "isolate_most_least_significant_one", issue = "136909")]

246

        #[must_use = "this returns the result of the operation, \

247

                      without modifying the original"]

248

        #[inline(always)]

249

        #[cfg(not(feature = "ferrocene_certified"))]

250

        pub const fn isolate_highest_one(self) -> Self {

251

            self & (((1 as $SelfT) << (<$SelfT>::BITS - 1)).wrapping_shr(self.leading_zeros()))

252

253

254

        /// Returns `self` with only the least significant bit set, or `0` if

255

        /// the input is `0`.

256

///

257

        /// # Examples

258

///

259

        /// ```

260

        /// #![feature(isolate_most_least_significant_one)]

261

///

262

        #[doc = concat!("let n: ", stringify!($SelfT), " = 0b_01100100;")]

263

///

264

        /// assert_eq!(n.isolate_lowest_one(), 0b_00000100);

265

        #[doc = concat!("assert_eq!(0_", stringify!($SelfT), ".isolate_lowest_one(), 0);")]

266

        /// ```

267

        #[unstable(feature = "isolate_most_least_significant_one", issue = "136909")]

268

        #[must_use = "this returns the result of the operation, \

269

                      without modifying the original"]

270

        #[inline(always)]

271

        #[cfg(not(feature = "ferrocene_certified"))]

272

        pub const fn isolate_lowest_one(self) -> Self {

273

            self & self.wrapping_neg()

274

275

276

        /// Returns the index of the highest bit set to one in `self`, or `None`

277

        /// if `self` is `0`.

278

///

279

        /// # Examples

280

///

281

        /// ```

282

        /// #![feature(int_lowest_highest_one)]

283

///

284

        #[doc = concat!("assert_eq!(0x0_", stringify!($SelfT), ".highest_one(), None);")]

285

        #[doc = concat!("assert_eq!(0x1_", stringify!($SelfT), ".highest_one(), Some(0));")]

286

        #[doc = concat!("assert_eq!(0x10_", stringify!($SelfT), ".highest_one(), Some(4));")]

287

        #[doc = concat!("assert_eq!(0x1f_", stringify!($SelfT), ".highest_one(), Some(4));")]

288

        /// ```

289

        #[unstable(feature = "int_lowest_highest_one", issue = "145203")]

290

        #[must_use = "this returns the result of the operation, \

291

                      without modifying the original"]

292

        #[inline(always)]

293

        #[cfg(not(feature = "ferrocene_certified"))]

294

        pub const fn highest_one(self) -> Option<u32> {

295

            match NonZero::new(self) {

296

                Some(v) => Some(v.highest_one()),

297

                None => None,

298

299

300

301

        /// Returns the index of the lowest bit set to one in `self`, or `None`

302

        /// if `self` is `0`.

303

///

304

        /// # Examples

305

///

306

        /// ```

307

        /// #![feature(int_lowest_highest_one)]

308

///

309

        #[doc = concat!("assert_eq!(0x0_", stringify!($SelfT), ".lowest_one(), None);")]

310

        #[doc = concat!("assert_eq!(0x1_", stringify!($SelfT), ".lowest_one(), Some(0));")]

311

        #[doc = concat!("assert_eq!(0x10_", stringify!($SelfT), ".lowest_one(), Some(4));")]

312

        #[doc = concat!("assert_eq!(0x1f_", stringify!($SelfT), ".lowest_one(), Some(0));")]

313

        /// ```

314

        #[unstable(feature = "int_lowest_highest_one", issue = "145203")]

315

        #[must_use = "this returns the result of the operation, \

316

                      without modifying the original"]

317

        #[inline(always)]

318

        #[cfg(not(feature = "ferrocene_certified"))]

319

        pub const fn lowest_one(self) -> Option<u32> {

320

            match NonZero::new(self) {

321

                Some(v) => Some(v.lowest_one()),

322

                None => None,

323

324

325

326

        /// Returns the bit pattern of `self` reinterpreted as a signed integer of the same size.

327

///

328

        /// This produces the same result as an `as` cast, but ensures that the bit-width remains

329

        /// the same.

330

///

331

        /// # Examples

332

///

333

        /// ```

334

        #[doc = concat!("let n = ", stringify!($SelfT), "::MAX;")]

335

///

336

        #[doc = concat!("assert_eq!(n.cast_signed(), -1", stringify!($SignedT), ");")]

337

        /// ```

338

        #[stable(feature = "integer_sign_cast", since = "1.87.0")]

339

        #[rustc_const_stable(feature = "integer_sign_cast", since = "1.87.0")]

340

        #[must_use = "this returns the result of the operation, \

341

                      without modifying the original"]

342

        #[inline(always)]

343

        #[cfg(not(feature = "ferrocene_certified"))]

344

        pub const fn cast_signed(self) -> $SignedT {

345

            self as $SignedT

346

347

348

        /// Shifts the bits to the left by a specified amount, `n`,

349

        /// wrapping the truncated bits to the end of the resulting integer.

350

///

351

        /// Please note this isn't the same operation as the `<<` shifting operator!

352

///

353

        /// # Examples

354

///

355

        /// ```

356

        #[doc = concat!("let n = ", $rot_op, stringify!($SelfT), ";")]

357

        #[doc = concat!("let m = ", $rot_result, ";")]

358

///

359

        #[doc = concat!("assert_eq!(n.rotate_left(", $rot, "), m);")]

360

        /// ```

361

        #[stable(feature = "rust1", since = "1.0.0")]

362

        #[rustc_const_stable(feature = "const_math", since = "1.32.0")]

363

        #[must_use = "this returns the result of the operation, \

364

                      without modifying the original"]

365

        #[inline(always)]

366

        #[cfg(not(feature = "ferrocene_certified"))]

367

        pub const fn rotate_left(self, n: u32) -> Self {

368

            return intrinsics::rotate_left(self, n);

369

370

371

        /// Shifts the bits to the right by a specified amount, `n`,

372

        /// wrapping the truncated bits to the beginning of the resulting

373

        /// integer.

374

///

375

        /// Please note this isn't the same operation as the `>>` shifting operator!

376

///

377

        /// # Examples

378

///

379

        /// ```

380

        #[doc = concat!("let n = ", $rot_result, stringify!($SelfT), ";")]

381

        #[doc = concat!("let m = ", $rot_op, ";")]

382

///

383

        #[doc = concat!("assert_eq!(n.rotate_right(", $rot, "), m);")]

384

        /// ```

385

        #[stable(feature = "rust1", since = "1.0.0")]

386

        #[rustc_const_stable(feature = "const_math", since = "1.32.0")]

387

        #[must_use = "this returns the result of the operation, \

388

                      without modifying the original"]

389

        #[inline(always)]

390

        #[cfg(not(feature = "ferrocene_certified"))]

391

        pub const fn rotate_right(self, n: u32) -> Self {

392

            return intrinsics::rotate_right(self, n);

393

394

395

        /// Performs a left funnel shift (concatenates `self` with `rhs`, with `self`

396

        /// making up the most significant half, then shifts the combined value left

397

        /// by `n`, and most significant half is extracted to produce the result).

398

///

399

        /// Please note this isn't the same operation as the `<<` shifting operator or

400

        /// [`rotate_left`](Self::rotate_left), although `a.funnel_shl(a, n)` is *equivalent*

401

        /// to `a.rotate_left(n)`.

402

///

403

        /// # Panics

404

///

405

        /// If `n` is greater than or equal to the number of bits in `self`

406

///

407

        /// # Examples

408

///

409

        /// Basic usage:

410

///

411

        /// ```

412

        /// #![feature(funnel_shifts)]

413

        #[doc = concat!("let a = ", $rot_op, stringify!($SelfT), ";")]

414

        #[doc = concat!("let b = ", $fsh_op, stringify!($SelfT), ";")]

415

        #[doc = concat!("let m = ", $fshl_result, ";")]

416

///

417

        #[doc = concat!("assert_eq!(a.funnel_shl(b, ", $rot, "), m);")]

418

        /// ```

419

        #[rustc_const_unstable(feature = "funnel_shifts", issue = "145686")]

420

        #[unstable(feature = "funnel_shifts", issue = "145686")]

421

        #[must_use = "this returns the result of the operation, \

422

                      without modifying the original"]

423

        #[inline(always)]

424

        #[cfg(not(feature = "ferrocene_certified"))]

425

        pub const fn funnel_shl(self, rhs: Self, n: u32) -> Self {

426

            assert!(n < Self::BITS, "attempt to funnel shift left with overflow");

427

            // SAFETY: just checked that `shift` is in-range

428

            unsafe { intrinsics::unchecked_funnel_shl(self, rhs, n) }

429

430

431

        /// Performs a right funnel shift (concatenates `self` and `rhs`, with `self`

432

        /// making up the most significant half, then shifts the combined value right

433

        /// by `n`, and least significant half is extracted to produce the result).

434

///

435

        /// Please note this isn't the same operation as the `>>` shifting operator or

436

        /// [`rotate_right`](Self::rotate_right), although `a.funnel_shr(a, n)` is *equivalent*

437

        /// to `a.rotate_right(n)`.

438

///

439

        /// # Panics

440

///

441

        /// If `n` is greater than or equal to the number of bits in `self`

442

///

443

        /// # Examples

444

///

445

        /// Basic usage:

446

///

447

        /// ```

448

        /// #![feature(funnel_shifts)]

449

        #[doc = concat!("let a = ", $rot_op, stringify!($SelfT), ";")]

450

        #[doc = concat!("let b = ", $fsh_op, stringify!($SelfT), ";")]

451

        #[doc = concat!("let m = ", $fshr_result, ";")]

452

///

453

        #[doc = concat!("assert_eq!(a.funnel_shr(b, ", $rot, "), m);")]

454

        /// ```

455

        #[rustc_const_unstable(feature = "funnel_shifts", issue = "145686")]

456

        #[unstable(feature = "funnel_shifts", issue = "145686")]

457

        #[must_use = "this returns the result of the operation, \

458

                      without modifying the original"]

459

        #[inline(always)]

460

        #[cfg(not(feature = "ferrocene_certified"))]

461

        pub const fn funnel_shr(self, rhs: Self, n: u32) -> Self {

462

            assert!(n < Self::BITS, "attempt to funnel shift right with overflow");

463

            // SAFETY: just checked that `shift` is in-range

464

            unsafe { intrinsics::unchecked_funnel_shr(self, rhs, n) }

465

466

467

        /// Reverses the byte order of the integer.

468

///

469

        /// # Examples

470

///

471

        /// ```

472

        #[doc = concat!("let n = ", $swap_op, stringify!($SelfT), ";")]

473

        /// let m = n.swap_bytes();

474

///

475

        #[doc = concat!("assert_eq!(m, ", $swapped, ");")]

476

        /// ```

477

        #[stable(feature = "rust1", since = "1.0.0")]

478

        #[rustc_const_stable(feature = "const_math", since = "1.32.0")]

479

        #[must_use = "this returns the result of the operation, \

480

                      without modifying the original"]

481

        #[inline(always)]

482

        #[cfg(not(feature = "ferrocene_certified"))]

483

        pub const fn swap_bytes(self) -> Self {

484

            intrinsics::bswap(self as $ActualT) as Self

485

486

487

        /// Reverses the order of bits in the integer. The least significant bit becomes the most significant bit,

488

        ///                 second least-significant bit becomes second most-significant bit, etc.

489

///

490

        /// # Examples

491

///

492

        /// ```

493

        #[doc = concat!("let n = ", $swap_op, stringify!($SelfT), ";")]

494

        /// let m = n.reverse_bits();

495

///

496

        #[doc = concat!("assert_eq!(m, ", $reversed, ");")]

497

        #[doc = concat!("assert_eq!(0, 0", stringify!($SelfT), ".reverse_bits());")]

498

        /// ```

499

        #[stable(feature = "reverse_bits", since = "1.37.0")]

500

        #[rustc_const_stable(feature = "reverse_bits", since = "1.37.0")]

501

        #[must_use = "this returns the result of the operation, \

502

                      without modifying the original"]

503

        #[inline(always)]

504

        #[cfg(not(feature = "ferrocene_certified"))]

505

        pub const fn reverse_bits(self) -> Self {

506

            intrinsics::bitreverse(self as $ActualT) as Self

507

508

509

        /// Converts an integer from big endian to the target's endianness.

510

///

511

        /// On big endian this is a no-op. On little endian the bytes are

512

        /// swapped.

513

///

514

        /// # Examples

515

///

516

        /// ```

517

        #[doc = concat!("let n = 0x1A", stringify!($SelfT), ";")]

518

///

519

        /// if cfg!(target_endian = "big") {

520

        #[doc = concat!("    assert_eq!(", stringify!($SelfT), "::from_be(n), n)")]

521

        /// } else {

522

        #[doc = concat!("    assert_eq!(", stringify!($SelfT), "::from_be(n), n.swap_bytes())")]

523

        /// }

524

        /// ```

525

        #[stable(feature = "rust1", since = "1.0.0")]

526

        #[rustc_const_stable(feature = "const_math", since = "1.32.0")]

527

        #[must_use]

528

        #[inline(always)]

529

        #[cfg(not(feature = "ferrocene_certified"))]

530

        pub const fn from_be(x: Self) -> Self {

531

            #[cfg(target_endian = "big")]

532

533

534

535

            #[cfg(not(target_endian = "big"))]

536

537

                x.swap_bytes()

538

539

540

541

        /// Converts an integer from little endian to the target's endianness.

542

///

543

        /// On little endian this is a no-op. On big endian the bytes are

544

        /// swapped.

545

///

546

        /// # Examples

547

///

548

        /// ```

549

        #[doc = concat!("let n = 0x1A", stringify!($SelfT), ";")]

550

///

551

        /// if cfg!(target_endian = "little") {

552

        #[doc = concat!("    assert_eq!(", stringify!($SelfT), "::from_le(n), n)")]

553

        /// } else {

554

        #[doc = concat!("    assert_eq!(", stringify!($SelfT), "::from_le(n), n.swap_bytes())")]

555

        /// }

556

        /// ```

557

        #[stable(feature = "rust1", since = "1.0.0")]

558

        #[rustc_const_stable(feature = "const_math", since = "1.32.0")]

559

        #[must_use]

560

        #[inline(always)]

561

        #[cfg(not(feature = "ferrocene_certified"))]

562

        pub const fn from_le(x: Self) -> Self {

563

            #[cfg(target_endian = "little")]

564

565

566

567

            #[cfg(not(target_endian = "little"))]

568

569

                x.swap_bytes()

570

571

572

573

        /// Converts `self` to big endian from the target's endianness.

574

///

575

        /// On big endian this is a no-op. On little endian the bytes are

576

        /// swapped.

577

///

578

        /// # Examples

579

///

580

        /// ```

581

        #[doc = concat!("let n = 0x1A", stringify!($SelfT), ";")]

582

///

583

        /// if cfg!(target_endian = "big") {

584

        ///     assert_eq!(n.to_be(), n)

585

        /// } else {

586

        ///     assert_eq!(n.to_be(), n.swap_bytes())

587

        /// }

588

        /// ```

589

        #[stable(feature = "rust1", since = "1.0.0")]

590

        #[rustc_const_stable(feature = "const_math", since = "1.32.0")]

591

        #[must_use = "this returns the result of the operation, \

592

                      without modifying the original"]

593

        #[inline(always)]

594

        #[cfg(not(feature = "ferrocene_certified"))]

595

        pub const fn to_be(self) -> Self { // or not to be?

596

            #[cfg(target_endian = "big")]

597

598

                self

599

600

            #[cfg(not(target_endian = "big"))]

601

602

                self.swap_bytes()

603

604

605

606

        /// Converts `self` to little endian from the target's endianness.

607

///

608

        /// On little endian this is a no-op. On big endian the bytes are

609

        /// swapped.

610

///

611

        /// # Examples

612

///

613

        /// ```

614

        #[doc = concat!("let n = 0x1A", stringify!($SelfT), ";")]

615

///

616

        /// if cfg!(target_endian = "little") {

617

        ///     assert_eq!(n.to_le(), n)

618

        /// } else {

619

        ///     assert_eq!(n.to_le(), n.swap_bytes())

620

        /// }

621

        /// ```

622

        #[stable(feature = "rust1", since = "1.0.0")]

623

        #[rustc_const_stable(feature = "const_math", since = "1.32.0")]

624

        #[must_use = "this returns the result of the operation, \

625

                      without modifying the original"]

626

        #[inline(always)]

627

        #[cfg(not(feature = "ferrocene_certified"))]

628

        pub const fn to_le(self) -> Self {

629

            #[cfg(target_endian = "little")]

630

631

                self

632

633

            #[cfg(not(target_endian = "little"))]

634

635

                self.swap_bytes()

636

637

638

639

        /// Checked integer addition. Computes `self + rhs`, returning `None`

640

        /// if overflow occurred.

641

///

642

        /// # Examples

643

///

644

        /// ```

645

        #[doc = concat!(

646

            "assert_eq!((", stringify!($SelfT), "::MAX - 2).checked_add(1), ",

647

            "Some(", stringify!($SelfT), "::MAX - 1));"

648

)]

649

        #[doc = concat!("assert_eq!((", stringify!($SelfT), "::MAX - 2).checked_add(3), None);")]

650

        /// ```

651

        #[stable(feature = "rust1", since = "1.0.0")]

652

        #[rustc_const_stable(feature = "const_checked_int_methods", since = "1.47.0")]

653

        #[must_use = "this returns the result of the operation, \

654

                      without modifying the original"]

655

        #[inline]

656

        #[cfg(not(feature = "ferrocene_certified"))]

657

        pub const fn checked_add(self, rhs: Self) -> Option<Self> {

658

            // This used to use `overflowing_add`, but that means it ends up being

659

            // a `wrapping_add`, losing some optimization opportunities. Notably,

660

            // phrasing it this way helps `.checked_add(1)` optimize to a check

661

            // against `MAX` and a `add nuw`.

662

            // Per <https://github.com/rust-lang/rust/pull/124114#issuecomment-2066173305>,

663

            // LLVM is happy to re-form the intrinsic later if useful.

664

665

            if intrinsics::unlikely(intrinsics::add_with_overflow(self, rhs).1) {

666

                None

667

            } else {

668

                // SAFETY: Just checked it doesn't overflow

669

                Some(unsafe { intrinsics::unchecked_add(self, rhs) })

670

671

672

673

        /// Strict integer addition. Computes `self + rhs`, panicking

674

        /// if overflow occurred.

675

///

676

        /// # Panics

677

///

678

        /// ## Overflow behavior

679

///

680

        /// This function will always panic on overflow, regardless of whether overflow checks are enabled.

681

///

682

        /// # Examples

683

///

684

        /// ```

685

        #[doc = concat!("assert_eq!((", stringify!($SelfT), "::MAX - 2).strict_add(1), ", stringify!($SelfT), "::MAX - 1);")]

686

        /// ```

687

///

688

        /// The following panics because of overflow:

689

///

690

        /// ```should_panic

691

        #[doc = concat!("let _ = (", stringify!($SelfT), "::MAX - 2).strict_add(3);")]

692

        /// ```

693

        #[stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

694

        #[rustc_const_stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

695

        #[must_use = "this returns the result of the operation, \

696

                      without modifying the original"]

697

        #[inline]

698

        #[track_caller]

699

        #[cfg(not(feature = "ferrocene_certified"))]

700

        pub const fn strict_add(self, rhs: Self) -> Self {

701

            let (a, b) = self.overflowing_add(rhs);

702

            if b { overflow_panic::add() } else { a }

703

704

705

        /// Unchecked integer addition. Computes `self + rhs`, assuming overflow

706

        /// cannot occur.

707

///

708

        /// Calling `x.unchecked_add(y)` is semantically equivalent to calling

709

        /// `x.`[`checked_add`]`(y).`[`unwrap_unchecked`]`()`.

710

///

711

        /// If you're just trying to avoid the panic in debug mode, then **do not**

712

        /// use this.  Instead, you're looking for [`wrapping_add`].

713

///

714

        /// # Safety

715

///

716

        /// This results in undefined behavior when

717

        #[doc = concat!("`self + rhs > ", stringify!($SelfT), "::MAX` or `self + rhs < ", stringify!($SelfT), "::MIN`,")]

718

        /// i.e. when [`checked_add`] would return `None`.

719

///

720

        /// [`unwrap_unchecked`]: option/enum.Option.html#method.unwrap_unchecked

721

        #[doc = concat!("[`checked_add`]: ", stringify!($SelfT), "::checked_add")]

722

        #[doc = concat!("[`wrapping_add`]: ", stringify!($SelfT), "::wrapping_add")]

723

        #[stable(feature = "unchecked_math", since = "1.79.0")]

724

        #[rustc_const_stable(feature = "unchecked_math", since = "1.79.0")]

725

        #[must_use = "this returns the result of the operation, \

726

                      without modifying the original"]

727

        #[inline(always)]

728

        #[track_caller]

729

        #[cfg(not(feature = "ferrocene_certified"))]

730

        pub const unsafe fn unchecked_add(self, rhs: Self) -> Self {

731

            assert_unsafe_precondition!(

732

                check_language_ub,

733

                concat!(stringify!($SelfT), "::unchecked_add cannot overflow"),

734

735

                    lhs: $SelfT = self,

736

                    rhs: $SelfT = rhs,

737

                ) => !lhs.overflowing_add(rhs).1,

738

);

739

740

            // SAFETY: this is guaranteed to be safe by the caller.

741

            unsafe {

742

                intrinsics::unchecked_add(self, rhs)

743

744

745

746

        /// Checked addition with a signed integer. Computes `self + rhs`,

747

        /// returning `None` if overflow occurred.

748

///

749

        /// # Examples

750

///

751

        /// ```

752

        #[doc = concat!("assert_eq!(1", stringify!($SelfT), ".checked_add_signed(2), Some(3));")]

753

        #[doc = concat!("assert_eq!(1", stringify!($SelfT), ".checked_add_signed(-2), None);")]

754

        #[doc = concat!("assert_eq!((", stringify!($SelfT), "::MAX - 2).checked_add_signed(3), None);")]

755

        /// ```

756

        #[stable(feature = "mixed_integer_ops", since = "1.66.0")]

757

        #[rustc_const_stable(feature = "mixed_integer_ops", since = "1.66.0")]

758

        #[must_use = "this returns the result of the operation, \

759

                      without modifying the original"]

760

        #[inline]

761

        #[cfg(not(feature = "ferrocene_certified"))]

762

        pub const fn checked_add_signed(self, rhs: $SignedT) -> Option<Self> {

763

            let (a, b) = self.overflowing_add_signed(rhs);

764

            if intrinsics::unlikely(b) { None } else { Some(a) }

765

766

767

        /// Strict addition with a signed integer. Computes `self + rhs`,

768

        /// panicking if overflow occurred.

769

///

770

        /// # Panics

771

///

772

        /// ## Overflow behavior

773

///

774

        /// This function will always panic on overflow, regardless of whether overflow checks are enabled.

775

///

776

        /// # Examples

777

///

778

        /// ```

779

        #[doc = concat!("assert_eq!(1", stringify!($SelfT), ".strict_add_signed(2), 3);")]

780

        /// ```

781

///

782

        /// The following panic because of overflow:

783

///

784

        /// ```should_panic

785

        #[doc = concat!("let _ = 1", stringify!($SelfT), ".strict_add_signed(-2);")]

786

        /// ```

787

///

788

        /// ```should_panic

789

        #[doc = concat!("let _ = (", stringify!($SelfT), "::MAX - 2).strict_add_signed(3);")]

790

        /// ```

791

        #[stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

792

        #[rustc_const_stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

793

        #[must_use = "this returns the result of the operation, \

794

                      without modifying the original"]

795

        #[inline]

796

        #[track_caller]

797

        #[cfg(not(feature = "ferrocene_certified"))]

798

        pub const fn strict_add_signed(self, rhs: $SignedT) -> Self {

799

            let (a, b) = self.overflowing_add_signed(rhs);

800

            if b { overflow_panic::add() } else { a }

801

802

803

        /// Checked integer subtraction. Computes `self - rhs`, returning

804

        /// `None` if overflow occurred.

805

///

806

        /// # Examples

807

///

808

        /// ```

809

        #[doc = concat!("assert_eq!(1", stringify!($SelfT), ".checked_sub(1), Some(0));")]

810

        #[doc = concat!("assert_eq!(0", stringify!($SelfT), ".checked_sub(1), None);")]

811

        /// ```

812

        #[stable(feature = "rust1", since = "1.0.0")]

813

        #[rustc_const_stable(feature = "const_checked_int_methods", since = "1.47.0")]

814

        #[must_use = "this returns the result of the operation, \

815

                      without modifying the original"]

816

        #[inline]

817

        #[cfg(not(feature = "ferrocene_certified"))]

818

        pub const fn checked_sub(self, rhs: Self) -> Option<Self> {

819

            // Per PR#103299, there's no advantage to the `overflowing` intrinsic

820

            // for *unsigned* subtraction and we just emit the manual check anyway.

821

            // Thus, rather than using `overflowing_sub` that produces a wrapping

822

            // subtraction, check it ourself so we can use an unchecked one.

823

824

            if self < rhs {

825

                None

826

            } else {

827

                // SAFETY: just checked this can't overflow

828

                Some(unsafe { intrinsics::unchecked_sub(self, rhs) })

829

830

831

832

        /// Strict integer subtraction. Computes `self - rhs`, panicking if

833

        /// overflow occurred.

834

///

835

        /// # Panics

836

///

837

        /// ## Overflow behavior

838

///

839

        /// This function will always panic on overflow, regardless of whether overflow checks are enabled.

840

///

841

        /// # Examples

842

///

843

        /// ```

844

        #[doc = concat!("assert_eq!(1", stringify!($SelfT), ".strict_sub(1), 0);")]

845

        /// ```

846

///

847

        /// The following panics because of overflow:

848

///

849

        /// ```should_panic

850

        #[doc = concat!("let _ = 0", stringify!($SelfT), ".strict_sub(1);")]

851

        /// ```

852

        #[stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

853

        #[rustc_const_stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

854

        #[must_use = "this returns the result of the operation, \

855

                      without modifying the original"]

856

        #[inline]

857

        #[track_caller]

858

        #[cfg(not(feature = "ferrocene_certified"))]

859

        pub const fn strict_sub(self, rhs: Self) -> Self {

860

            let (a, b) = self.overflowing_sub(rhs);

861

            if b { overflow_panic::sub() } else { a }

862

863

864

        /// Unchecked integer subtraction. Computes `self - rhs`, assuming overflow

865

        /// cannot occur.

866

///

867

        /// Calling `x.unchecked_sub(y)` is semantically equivalent to calling

868

        /// `x.`[`checked_sub`]`(y).`[`unwrap_unchecked`]`()`.

869

///

870

        /// If you're just trying to avoid the panic in debug mode, then **do not**

871

        /// use this.  Instead, you're looking for [`wrapping_sub`].

872

///

873

        /// If you find yourself writing code like this:

874

///

875

        /// ```

876

        /// # let foo = 30_u32;

877

        /// # let bar = 20;

878

        /// if foo >= bar {

879

        ///     // SAFETY: just checked it will not overflow

880

        ///     let diff = unsafe { foo.unchecked_sub(bar) };

881

        ///     // ... use diff ...

882

        /// }

883

        /// ```

884

///

885

        /// Consider changing it to

886

///

887

        /// ```

888

        /// # let foo = 30_u32;

889

        /// # let bar = 20;

890

        /// if let Some(diff) = foo.checked_sub(bar) {

891

        ///     // ... use diff ...

892

        /// }

893

        /// ```

894

///

895

        /// As that does exactly the same thing -- including telling the optimizer

896

        /// that the subtraction cannot overflow -- but avoids needing `unsafe`.

897

///

898

        /// # Safety

899

///

900

        /// This results in undefined behavior when

901

        #[doc = concat!("`self - rhs > ", stringify!($SelfT), "::MAX` or `self - rhs < ", stringify!($SelfT), "::MIN`,")]

902

        /// i.e. when [`checked_sub`] would return `None`.

903

///

904

        /// [`unwrap_unchecked`]: option/enum.Option.html#method.unwrap_unchecked

905

        #[doc = concat!("[`checked_sub`]: ", stringify!($SelfT), "::checked_sub")]

906

        #[doc = concat!("[`wrapping_sub`]: ", stringify!($SelfT), "::wrapping_sub")]

907

        #[stable(feature = "unchecked_math", since = "1.79.0")]

908

        #[rustc_const_stable(feature = "unchecked_math", since = "1.79.0")]

909

        #[must_use = "this returns the result of the operation, \

910

                      without modifying the original"]

911

        #[inline(always)]

912

        #[track_caller]

913

        #[cfg(not(feature = "ferrocene_certified"))]

914

        pub const unsafe fn unchecked_sub(self, rhs: Self) -> Self {

915

            assert_unsafe_precondition!(

916

                check_language_ub,

917

                concat!(stringify!($SelfT), "::unchecked_sub cannot overflow"),

918

919

                    lhs: $SelfT = self,

920

                    rhs: $SelfT = rhs,

921

                ) => !lhs.overflowing_sub(rhs).1,

922

);

923

924

            // SAFETY: this is guaranteed to be safe by the caller.

925

            unsafe {

926

                intrinsics::unchecked_sub(self, rhs)

927

928

929

930

        /// Checked subtraction with a signed integer. Computes `self - rhs`,

931

        /// returning `None` if overflow occurred.

932

///

933

        /// # Examples

934

///

935

        /// ```

936

        #[doc = concat!("assert_eq!(1", stringify!($SelfT), ".checked_sub_signed(2), None);")]

937

        #[doc = concat!("assert_eq!(1", stringify!($SelfT), ".checked_sub_signed(-2), Some(3));")]

938

        #[doc = concat!("assert_eq!((", stringify!($SelfT), "::MAX - 2).checked_sub_signed(-4), None);")]

939

        /// ```

940

        #[stable(feature = "mixed_integer_ops_unsigned_sub", since = "1.90.0")]

941

        #[rustc_const_stable(feature = "mixed_integer_ops_unsigned_sub", since = "1.90.0")]

942

        #[must_use = "this returns the result of the operation, \

943

                      without modifying the original"]

944

        #[inline]

945

        #[cfg(not(feature = "ferrocene_certified"))]

946

        pub const fn checked_sub_signed(self, rhs: $SignedT) -> Option<Self> {

947

            let (res, overflow) = self.overflowing_sub_signed(rhs);

948

949

            if !overflow {

950

                Some(res)

951

            } else {

952

                None

953

954

955

956

        /// Strict subtraction with a signed integer. Computes `self - rhs`,

957

        /// panicking if overflow occurred.

958

///

959

        /// # Panics

960

///

961

        /// ## Overflow behavior

962

///

963

        /// This function will always panic on overflow, regardless of whether overflow checks are enabled.

964

///

965

        /// # Examples

966

///

967

        /// ```

968

        #[doc = concat!("assert_eq!(3", stringify!($SelfT), ".strict_sub_signed(2), 1);")]

969

        /// ```

970

///

971

        /// The following panic because of overflow:

972

///

973

        /// ```should_panic

974

        #[doc = concat!("let _ = 1", stringify!($SelfT), ".strict_sub_signed(2);")]

975

        /// ```

976

///

977

        /// ```should_panic

978

        #[doc = concat!("let _ = (", stringify!($SelfT), "::MAX).strict_sub_signed(-1);")]

979

        /// ```

980

        #[stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

981

        #[rustc_const_stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

982

        #[must_use = "this returns the result of the operation, \

983

                      without modifying the original"]

984

        #[inline]

985

        #[track_caller]

986

        #[cfg(not(feature = "ferrocene_certified"))]

987

        pub const fn strict_sub_signed(self, rhs: $SignedT) -> Self {

988

            let (a, b) = self.overflowing_sub_signed(rhs);

989

            if b { overflow_panic::sub() } else { a }

990

991

992

        #[doc = concat!(

993

            "Checked integer subtraction. Computes `self - rhs` and checks if the result fits into an [`",

994

            stringify!($SignedT), "`], returning `None` if overflow occurred."

995

)]

996

///

997

        /// # Examples

998

///

999

        /// ```

1000

        #[doc = concat!("assert_eq!(10", stringify!($SelfT), ".checked_signed_diff(2), Some(8));")]

1001

        #[doc = concat!("assert_eq!(2", stringify!($SelfT), ".checked_signed_diff(10), Some(-8));")]

1002

        #[doc = concat!(

1003

            "assert_eq!(",

1004

            stringify!($SelfT),

1005

            "::MAX.checked_signed_diff(",

1006

            stringify!($SignedT),

1007

            "::MAX as ",

1008

            stringify!($SelfT),

1009

            "), None);"

1010

)]

1011

        #[doc = concat!(

1012

            "assert_eq!((",

1013

            stringify!($SignedT),

1014

            "::MAX as ",

1015

            stringify!($SelfT),

1016

            ").checked_signed_diff(",

1017

            stringify!($SelfT),

1018

            "::MAX), Some(",

1019

            stringify!($SignedT),

1020

            "::MIN));"

1021

)]

1022

        #[doc = concat!(

1023

            "assert_eq!((",

1024

            stringify!($SignedT),

1025

            "::MAX as ",

1026

            stringify!($SelfT),

1027

            " + 1).checked_signed_diff(0), None);"

1028

)]

1029

        #[doc = concat!(

1030

            "assert_eq!(",

1031

            stringify!($SelfT),

1032

            "::MAX.checked_signed_diff(",

1033

            stringify!($SelfT),

1034

            "::MAX), Some(0));"

1035

)]

1036

        /// ```

1037

        #[stable(feature = "unsigned_signed_diff", since = "CURRENT_RUSTC_VERSION")]

1038

        #[rustc_const_stable(feature = "unsigned_signed_diff", since = "CURRENT_RUSTC_VERSION")]

1039

        #[inline]

1040

        #[cfg(not(feature = "ferrocene_certified"))]

1041

        pub const fn checked_signed_diff(self, rhs: Self) -> Option<$SignedT> {

1042

            let res = self.wrapping_sub(rhs) as $SignedT;

1043

            let overflow = (self >= rhs) == (res < 0);

1044

1045

            if !overflow {

1046

                Some(res)

1047

            } else {

1048

                None

1049

1050

1051

1052

        /// Checked integer multiplication. Computes `self * rhs`, returning

1053

        /// `None` if overflow occurred.

1054

///

1055

        /// # Examples

1056

///

1057

        /// ```

1058

        #[doc = concat!("assert_eq!(5", stringify!($SelfT), ".checked_mul(1), Some(5));")]

1059

        #[doc = concat!("assert_eq!(", stringify!($SelfT), "::MAX.checked_mul(2), None);")]

1060

        /// ```

1061

        #[stable(feature = "rust1", since = "1.0.0")]

1062

        #[rustc_const_stable(feature = "const_checked_int_methods", since = "1.47.0")]

1063

        #[must_use = "this returns the result of the operation, \

1064

                      without modifying the original"]

1065

        #[inline]

1066

        #[cfg(not(feature = "ferrocene_certified"))]

1067

        pub const fn checked_mul(self, rhs: Self) -> Option<Self> {

1068

            let (a, b) = self.overflowing_mul(rhs);

1069

            if intrinsics::unlikely(b) { None } else { Some(a) }

1070

1071

1072

        /// Strict integer multiplication. Computes `self * rhs`, panicking if

1073

        /// overflow occurred.

1074

///

1075

        /// # Panics

1076

///

1077

        /// ## Overflow behavior

1078

///

1079

        /// This function will always panic on overflow, regardless of whether overflow checks are enabled.

1080

///

1081

        /// # Examples

1082

///

1083

        /// ```

1084

        #[doc = concat!("assert_eq!(5", stringify!($SelfT), ".strict_mul(1), 5);")]

1085

        /// ```

1086

///

1087

        /// The following panics because of overflow:

1088

///

1089

        /// ``` should_panic

1090

        #[doc = concat!("let _ = ", stringify!($SelfT), "::MAX.strict_mul(2);")]

1091

        /// ```

1092

        #[stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

1093

        #[rustc_const_stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

1094

        #[must_use = "this returns the result of the operation, \

1095

                      without modifying the original"]

1096

        #[inline]

1097

        #[track_caller]

1098

        #[cfg(not(feature = "ferrocene_certified"))]

1099

        pub const fn strict_mul(self, rhs: Self) -> Self {

1100

            let (a, b) = self.overflowing_mul(rhs);

1101

            if b { overflow_panic::mul() } else { a }

1102

1103

1104

        /// Unchecked integer multiplication. Computes `self * rhs`, assuming overflow

1105

        /// cannot occur.

1106

///

1107

        /// Calling `x.unchecked_mul(y)` is semantically equivalent to calling

1108

        /// `x.`[`checked_mul`]`(y).`[`unwrap_unchecked`]`()`.

1109

///

1110

        /// If you're just trying to avoid the panic in debug mode, then **do not**

1111

        /// use this.  Instead, you're looking for [`wrapping_mul`].

1112

///

1113

        /// # Safety

1114

///

1115

        /// This results in undefined behavior when

1116

        #[doc = concat!("`self * rhs > ", stringify!($SelfT), "::MAX` or `self * rhs < ", stringify!($SelfT), "::MIN`,")]

1117

        /// i.e. when [`checked_mul`] would return `None`.

1118

///

1119

        /// [`unwrap_unchecked`]: option/enum.Option.html#method.unwrap_unchecked

1120

        #[doc = concat!("[`checked_mul`]: ", stringify!($SelfT), "::checked_mul")]

1121

        #[doc = concat!("[`wrapping_mul`]: ", stringify!($SelfT), "::wrapping_mul")]

1122

        #[stable(feature = "unchecked_math", since = "1.79.0")]

1123

        #[rustc_const_stable(feature = "unchecked_math", since = "1.79.0")]

1124

        #[must_use = "this returns the result of the operation, \

1125

                      without modifying the original"]

1126

        #[inline(always)]

1127

        #[track_caller]

1128

        #[cfg(not(feature = "ferrocene_certified"))]

1129

        pub const unsafe fn unchecked_mul(self, rhs: Self) -> Self {

1130

            assert_unsafe_precondition!(

1131

                check_language_ub,

1132

                concat!(stringify!($SelfT), "::unchecked_mul cannot overflow"),

1133

1134

                    lhs: $SelfT = self,

1135

                    rhs: $SelfT = rhs,

1136

                ) => !lhs.overflowing_mul(rhs).1,

1137

);

1138

1139

            // SAFETY: this is guaranteed to be safe by the caller.

1140

            unsafe {

1141

                intrinsics::unchecked_mul(self, rhs)

1142

1143

1144

1145

        /// Checked integer division. Computes `self / rhs`, returning `None`

1146

        /// if `rhs == 0`.

1147

///

1148

        /// # Examples

1149

///

1150

        /// ```

1151

        #[doc = concat!("assert_eq!(128", stringify!($SelfT), ".checked_div(2), Some(64));")]

1152

        #[doc = concat!("assert_eq!(1", stringify!($SelfT), ".checked_div(0), None);")]

1153

        /// ```

1154

        #[stable(feature = "rust1", since = "1.0.0")]

1155

        #[rustc_const_stable(feature = "const_checked_int_div", since = "1.52.0")]

1156

        #[must_use = "this returns the result of the operation, \

1157

                      without modifying the original"]

1158

        #[inline]

1159

        #[cfg(not(feature = "ferrocene_certified"))]

1160

        pub const fn checked_div(self, rhs: Self) -> Option<Self> {

1161

            if intrinsics::unlikely(rhs == 0) {

1162

                None

1163

            } else {

1164

                // SAFETY: div by zero has been checked above and unsigned types have no other

1165

                // failure modes for division

1166

                Some(unsafe { intrinsics::unchecked_div(self, rhs) })

1167

1168

1169

1170

        /// Strict integer division. Computes `self / rhs`.

1171

///

1172

        /// Strict division on unsigned types is just normal division. There's no

1173

        /// way overflow could ever happen. This function exists so that all

1174

        /// operations are accounted for in the strict operations.

1175

///

1176

        /// # Panics

1177

///

1178

        /// This function will panic if `rhs` is zero.

1179

///

1180

        /// # Examples

1181

///

1182

        /// ```

1183

        #[doc = concat!("assert_eq!(100", stringify!($SelfT), ".strict_div(10), 10);")]

1184

        /// ```

1185

///

1186

        /// The following panics because of division by zero:

1187

///

1188

        /// ```should_panic

1189

        #[doc = concat!("let _ = (1", stringify!($SelfT), ").strict_div(0);")]

1190

        /// ```

1191

        #[stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

1192

        #[rustc_const_stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

1193

        #[must_use = "this returns the result of the operation, \

1194

                      without modifying the original"]

1195

        #[inline(always)]

1196

        #[track_caller]

1197

        #[cfg(not(feature = "ferrocene_certified"))]

1198

        pub const fn strict_div(self, rhs: Self) -> Self {

1199

            self / rhs

1200

1201

1202

        /// Checked Euclidean division. Computes `self.div_euclid(rhs)`, returning `None`

1203

        /// if `rhs == 0`.

1204

///

1205

        /// # Examples

1206

///

1207

        /// ```

1208

        #[doc = concat!("assert_eq!(128", stringify!($SelfT), ".checked_div_euclid(2), Some(64));")]

1209

        #[doc = concat!("assert_eq!(1", stringify!($SelfT), ".checked_div_euclid(0), None);")]

1210

        /// ```

1211

        #[stable(feature = "euclidean_division", since = "1.38.0")]

1212

        #[rustc_const_stable(feature = "const_euclidean_int_methods", since = "1.52.0")]

1213

        #[must_use = "this returns the result of the operation, \

1214

                      without modifying the original"]

1215

        #[inline]

1216

        #[cfg(not(feature = "ferrocene_certified"))]

1217

        pub const fn checked_div_euclid(self, rhs: Self) -> Option<Self> {

1218

            if intrinsics::unlikely(rhs == 0) {

1219

                None

1220

            } else {

1221

                Some(self.div_euclid(rhs))

1222

1223

1224

1225

        /// Strict Euclidean division. Computes `self.div_euclid(rhs)`.

1226

///

1227

        /// Strict division on unsigned types is just normal division. There's no

1228

        /// way overflow could ever happen. This function exists so that all

1229

        /// operations are accounted for in the strict operations. Since, for the

1230

        /// positive integers, all common definitions of division are equal, this

1231

        /// is exactly equal to `self.strict_div(rhs)`.

1232

///

1233

        /// # Panics

1234

///

1235

        /// This function will panic if `rhs` is zero.

1236

///

1237

        /// # Examples

1238

///

1239

        /// ```

1240

        #[doc = concat!("assert_eq!(100", stringify!($SelfT), ".strict_div_euclid(10), 10);")]

1241

        /// ```

1242

        /// The following panics because of division by zero:

1243

///

1244

        /// ```should_panic

1245

        #[doc = concat!("let _ = (1", stringify!($SelfT), ").strict_div_euclid(0);")]

1246

        /// ```

1247

        #[stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

1248

        #[rustc_const_stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

1249

        #[must_use = "this returns the result of the operation, \

1250

                      without modifying the original"]

1251

        #[inline(always)]

1252

        #[track_caller]

1253

        #[cfg(not(feature = "ferrocene_certified"))]

1254

        pub const fn strict_div_euclid(self, rhs: Self) -> Self {

1255

            self / rhs

1256

1257

1258

        /// Checked integer division without remainder. Computes `self / rhs`,

1259

        /// returning `None` if `rhs == 0` or if `self % rhs != 0`.

1260

///

1261

        /// # Examples

1262

///

1263

        /// ```

1264

        /// #![feature(exact_div)]

1265

        #[doc = concat!("assert_eq!(64", stringify!($SelfT), ".checked_exact_div(2), Some(32));")]

1266

        #[doc = concat!("assert_eq!(64", stringify!($SelfT), ".checked_exact_div(32), Some(2));")]

1267

        #[doc = concat!("assert_eq!(64", stringify!($SelfT), ".checked_exact_div(0), None);")]

1268

        #[doc = concat!("assert_eq!(65", stringify!($SelfT), ".checked_exact_div(2), None);")]

1269

        /// ```

1270

        #[unstable(

1271

            feature = "exact_div",

1272

            issue = "139911",

1273

)]

1274

        #[must_use = "this returns the result of the operation, \

1275

                      without modifying the original"]

1276

        #[inline]

1277

        #[cfg(not(feature = "ferrocene_certified"))]

1278

        pub const fn checked_exact_div(self, rhs: Self) -> Option<Self> {

1279

            if intrinsics::unlikely(rhs == 0) {

1280

                None

1281

            } else {

1282

                // SAFETY: division by zero is checked above

1283

                unsafe {

1284

                    if intrinsics::unlikely(intrinsics::unchecked_rem(self, rhs) != 0) {

1285

                        None

1286

                    } else {

1287

                        Some(intrinsics::exact_div(self, rhs))

1288

1289

1290

1291

1292

1293

        /// Checked integer division without remainder. Computes `self / rhs`.

1294

///

1295

        /// # Panics

1296

///

1297

        /// This function will panic  if `rhs == 0` or `self % rhs != 0`.

1298

///

1299

        /// # Examples

1300

///

1301

        /// ```

1302

        /// #![feature(exact_div)]

1303

        #[doc = concat!("assert_eq!(64", stringify!($SelfT), ".exact_div(2), 32);")]

1304

        #[doc = concat!("assert_eq!(64", stringify!($SelfT), ".exact_div(32), 2);")]

1305

        /// ```

1306

///

1307

        /// ```should_panic

1308

        /// #![feature(exact_div)]

1309

        #[doc = concat!("let _ = 65", stringify!($SelfT), ".exact_div(2);")]

1310

        /// ```

1311

        #[unstable(

1312

            feature = "exact_div",

1313

            issue = "139911",

1314

)]

1315

        #[must_use = "this returns the result of the operation, \

1316

                      without modifying the original"]

1317

        #[inline]

1318

        #[cfg(not(feature = "ferrocene_certified"))]

1319

        pub const fn exact_div(self, rhs: Self) -> Self {

1320

            match self.checked_exact_div(rhs) {

1321

                Some(x) => x,

1322

                None => panic!("Failed to divide without remainder"),

1323

1324

1325

1326

        /// Unchecked integer division without remainder. Computes `self / rhs`.

1327

///

1328

        /// # Safety

1329

///

1330

        /// This results in undefined behavior when `rhs == 0` or `self % rhs != 0`,

1331

        /// i.e. when [`checked_exact_div`](Self::checked_exact_div) would return `None`.

1332

        #[unstable(

1333

            feature = "exact_div",

1334

            issue = "139911",

1335

)]

1336

        #[must_use = "this returns the result of the operation, \

1337

                      without modifying the original"]

1338

        #[inline]

1339

        #[cfg(not(feature = "ferrocene_certified"))]

1340

        pub const unsafe fn unchecked_exact_div(self, rhs: Self) -> Self {

1341

            assert_unsafe_precondition!(

1342

                check_language_ub,

1343

                concat!(stringify!($SelfT), "::unchecked_exact_div divide by zero or leave a remainder"),

1344

1345

                    lhs: $SelfT = self,

1346

                    rhs: $SelfT = rhs,

1347

                ) => rhs > 0 && lhs % rhs == 0,

1348

);

1349

            // SAFETY: Same precondition

1350

            unsafe { intrinsics::exact_div(self, rhs) }

1351

1352

1353

        /// Checked integer remainder. Computes `self % rhs`, returning `None`

1354

        /// if `rhs == 0`.

1355

///

1356

        /// # Examples

1357

///

1358

        /// ```

1359

        #[doc = concat!("assert_eq!(5", stringify!($SelfT), ".checked_rem(2), Some(1));")]

1360

        #[doc = concat!("assert_eq!(5", stringify!($SelfT), ".checked_rem(0), None);")]

1361

        /// ```

1362

        #[stable(feature = "wrapping", since = "1.7.0")]

1363

        #[rustc_const_stable(feature = "const_checked_int_div", since = "1.52.0")]

1364

        #[must_use = "this returns the result of the operation, \

1365

                      without modifying the original"]

1366

        #[inline]

1367

        #[cfg(not(feature = "ferrocene_certified"))]

1368

        pub const fn checked_rem(self, rhs: Self) -> Option<Self> {

1369

            if intrinsics::unlikely(rhs == 0) {

1370

                None

1371

            } else {

1372

                // SAFETY: div by zero has been checked above and unsigned types have no other

1373

                // failure modes for division

1374

                Some(unsafe { intrinsics::unchecked_rem(self, rhs) })

1375

1376

1377

1378

        /// Strict integer remainder. Computes `self % rhs`.

1379

///

1380

        /// Strict remainder calculation on unsigned types is just the regular

1381

        /// remainder calculation. There's no way overflow could ever happen.

1382

        /// This function exists so that all operations are accounted for in the

1383

        /// strict operations.

1384

///

1385

        /// # Panics

1386

///

1387

        /// This function will panic if `rhs` is zero.

1388

///

1389

        /// # Examples

1390

///

1391

        /// ```

1392

        #[doc = concat!("assert_eq!(100", stringify!($SelfT), ".strict_rem(10), 0);")]

1393

        /// ```

1394

///

1395

        /// The following panics because of division by zero:

1396

///

1397

        /// ```should_panic

1398

        #[doc = concat!("let _ = 5", stringify!($SelfT), ".strict_rem(0);")]

1399

        /// ```

1400

        #[stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

1401

        #[rustc_const_stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

1402

        #[must_use = "this returns the result of the operation, \

1403

                      without modifying the original"]

1404

        #[inline(always)]

1405

        #[track_caller]

1406

        #[cfg(not(feature = "ferrocene_certified"))]

1407

        pub const fn strict_rem(self, rhs: Self) -> Self {

1408

            self % rhs

1409

1410

1411

        /// Checked Euclidean modulo. Computes `self.rem_euclid(rhs)`, returning `None`

1412

        /// if `rhs == 0`.

1413

///

1414

        /// # Examples

1415

///

1416

        /// ```

1417

        #[doc = concat!("assert_eq!(5", stringify!($SelfT), ".checked_rem_euclid(2), Some(1));")]

1418

        #[doc = concat!("assert_eq!(5", stringify!($SelfT), ".checked_rem_euclid(0), None);")]

1419

        /// ```

1420

        #[stable(feature = "euclidean_division", since = "1.38.0")]

1421

        #[rustc_const_stable(feature = "const_euclidean_int_methods", since = "1.52.0")]

1422

        #[must_use = "this returns the result of the operation, \

1423

                      without modifying the original"]

1424

        #[inline]

1425

        #[cfg(not(feature = "ferrocene_certified"))]

1426

        pub const fn checked_rem_euclid(self, rhs: Self) -> Option<Self> {

1427

            if intrinsics::unlikely(rhs == 0) {

1428

                None

1429

            } else {

1430

                Some(self.rem_euclid(rhs))

1431

1432

1433

1434

        /// Strict Euclidean modulo. Computes `self.rem_euclid(rhs)`.

1435

///

1436

        /// Strict modulo calculation on unsigned types is just the regular

1437

        /// remainder calculation. There's no way overflow could ever happen.

1438

        /// This function exists so that all operations are accounted for in the

1439

        /// strict operations. Since, for the positive integers, all common

1440

        /// definitions of division are equal, this is exactly equal to

1441

        /// `self.strict_rem(rhs)`.

1442

///

1443

        /// # Panics

1444

///

1445

        /// This function will panic if `rhs` is zero.

1446

///

1447

        /// # Examples

1448

///

1449

        /// ```

1450

        #[doc = concat!("assert_eq!(100", stringify!($SelfT), ".strict_rem_euclid(10), 0);")]

1451

        /// ```

1452

///

1453

        /// The following panics because of division by zero:

1454

///

1455

        /// ```should_panic

1456

        #[doc = concat!("let _ = 5", stringify!($SelfT), ".strict_rem_euclid(0);")]

1457

        /// ```

1458

        #[stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

1459

        #[rustc_const_stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

1460

        #[must_use = "this returns the result of the operation, \

1461

                      without modifying the original"]

1462

        #[inline(always)]

1463

        #[track_caller]

1464

        #[cfg(not(feature = "ferrocene_certified"))]

1465

        pub const fn strict_rem_euclid(self, rhs: Self) -> Self {

1466

            self % rhs

1467

1468

1469

        /// Same value as `self | other`, but UB if any bit position is set in both inputs.

1470

///

1471

        /// This is a situational micro-optimization for places where you'd rather

1472

        /// use addition on some platforms and bitwise or on other platforms, based

1473

        /// on exactly which instructions combine better with whatever else you're

1474

        /// doing.  Note that there's no reason to bother using this for places

1475

        /// where it's clear from the operations involved that they can't overlap.

1476

        /// For example, if you're combining `u16`s into a `u32` with

1477

        /// `((a as u32) << 16) | (b as u32)`, that's fine, as the backend will

1478

        /// know those sides of the `|` are disjoint without needing help.

1479

///

1480

        /// # Examples

1481

///

1482

        /// ```

1483

        /// #![feature(disjoint_bitor)]

1484

///

1485

        /// // SAFETY: `1` and `4` have no bits in common.

1486

        /// unsafe {

1487

        #[doc = concat!("    assert_eq!(1_", stringify!($SelfT), ".unchecked_disjoint_bitor(4), 5);")]

1488

        /// }

1489

        /// ```

1490

///

1491

        /// # Safety

1492

///

1493

        /// Requires that `(self & other) == 0`, otherwise it's immediate UB.

1494

///

1495

        /// Equivalently, requires that `(self | other) == (self + other)`.

1496

        #[unstable(feature = "disjoint_bitor", issue = "135758")]

1497

        #[rustc_const_unstable(feature = "disjoint_bitor", issue = "135758")]

1498

        #[inline]

1499

        #[cfg(not(feature = "ferrocene_certified"))]

1500

        pub const unsafe fn unchecked_disjoint_bitor(self, other: Self) -> Self {

1501

            assert_unsafe_precondition!(

1502

                check_language_ub,

1503

                concat!(stringify!($SelfT), "::unchecked_disjoint_bitor cannot have overlapping bits"),

1504

1505

                    lhs: $SelfT = self,

1506

                    rhs: $SelfT = other,

1507

                ) => (lhs & rhs) == 0,

1508

);

1509

1510

            // SAFETY: Same precondition

1511

            unsafe { intrinsics::disjoint_bitor(self, other) }

1512

1513

1514

        /// Returns the logarithm of the number with respect to an arbitrary base,

1515

        /// rounded down.

1516

///

1517

        /// This method might not be optimized owing to implementation details;

1518

        /// `ilog2` can produce results more efficiently for base 2, and `ilog10`

1519

        /// can produce results more efficiently for base 10.

1520

///

1521

        /// # Panics

1522

///

1523

        /// This function will panic if `self` is zero, or if `base` is less than 2.

1524

///

1525

        /// # Examples

1526

///

1527

        /// ```

1528

        #[doc = concat!("assert_eq!(5", stringify!($SelfT), ".ilog(5), 1);")]

1529

        /// ```

1530

        #[stable(feature = "int_log", since = "1.67.0")]

1531

        #[rustc_const_stable(feature = "int_log", since = "1.67.0")]

1532

        #[must_use = "this returns the result of the operation, \

1533

                      without modifying the original"]

1534

        #[inline]

1535

        #[track_caller]

1536

        #[cfg(not(feature = "ferrocene_certified"))]

1537

        pub const fn ilog(self, base: Self) -> u32 {

1538

            assert!(base >= 2, "base of integer logarithm must be at least 2");

1539

            if let Some(log) = self.checked_ilog(base) {

1540

log

1541

            } else {

1542

                int_log10::panic_for_nonpositive_argument()

1543

1544

1545

1546

        /// Returns the base 2 logarithm of the number, rounded down.

1547

///

1548

        /// # Panics

1549

///

1550

        /// This function will panic if `self` is zero.

1551

///

1552

        /// # Examples

1553

///

1554

        /// ```

1555

        #[doc = concat!("assert_eq!(2", stringify!($SelfT), ".ilog2(), 1);")]

1556

        /// ```

1557

        #[stable(feature = "int_log", since = "1.67.0")]

1558

        #[rustc_const_stable(feature = "int_log", since = "1.67.0")]

1559

        #[must_use = "this returns the result of the operation, \

1560

                      without modifying the original"]

1561

        #[inline]

1562

        #[track_caller]

1563

        #[cfg(not(feature = "ferrocene_certified"))]

1564

        pub const fn ilog2(self) -> u32 {

1565

            if let Some(log) = self.checked_ilog2() {

1566

log

1567

            } else {

1568

                int_log10::panic_for_nonpositive_argument()

1569

1570

1571

1572

        /// Returns the base 10 logarithm of the number, rounded down.

1573

///

1574

        /// # Panics

1575

///

1576

        /// This function will panic if `self` is zero.

1577

///

1578

        /// # Example

1579

///

1580

        /// ```

1581

        #[doc = concat!("assert_eq!(10", stringify!($SelfT), ".ilog10(), 1);")]

1582

        /// ```

1583

        #[stable(feature = "int_log", since = "1.67.0")]

1584

        #[rustc_const_stable(feature = "int_log", since = "1.67.0")]

1585

        #[must_use = "this returns the result of the operation, \

1586

                      without modifying the original"]

1587

        #[inline]

1588

        #[track_caller]

1589

        #[cfg(not(feature = "ferrocene_certified"))]

1590

        pub const fn ilog10(self) -> u32 {

1591

            if let Some(log) = self.checked_ilog10() {

1592

log

1593

            } else {

1594

                int_log10::panic_for_nonpositive_argument()

1595

1596

1597

1598

        /// Returns the logarithm of the number with respect to an arbitrary base,

1599

        /// rounded down.

1600

///

1601

        /// Returns `None` if the number is zero, or if the base is not at least 2.

1602

///

1603

        /// This method might not be optimized owing to implementation details;

1604

        /// `checked_ilog2` can produce results more efficiently for base 2, and

1605

        /// `checked_ilog10` can produce results more efficiently for base 10.

1606

///

1607

        /// # Examples

1608

///

1609

        /// ```

1610

        #[doc = concat!("assert_eq!(5", stringify!($SelfT), ".checked_ilog(5), Some(1));")]

1611

        /// ```

1612

        #[stable(feature = "int_log", since = "1.67.0")]

1613

        #[rustc_const_stable(feature = "int_log", since = "1.67.0")]

1614

        #[must_use = "this returns the result of the operation, \

1615

                      without modifying the original"]

1616

        #[inline]

1617

        #[cfg(not(feature = "ferrocene_certified"))]

1618

        pub const fn checked_ilog(self, base: Self) -> Option<u32> {

1619

            // Inform compiler of optimizations when the base is known at

1620

            // compile time and there's a cheaper method available.

1621

//

1622

            // Note: Like all optimizations, this is not guaranteed to be

1623

            // applied by the compiler. If you want those specific bases,

1624

            // use `.checked_ilog2()` or `.checked_ilog10()` directly.

1625

            if core::intrinsics::is_val_statically_known(base) {

1626

                if base == 2 {

1627

                    return self.checked_ilog2();

1628

                } else if base == 10 {

1629

                    return self.checked_ilog10();

1630

1631

1632

1633

            if self <= 0 || base <= 1 {

1634

                None

1635

            } else if self < base {

1636

                Some(0)

1637

            } else {

1638

                // Since base >= self, n >= 1

1639

                let mut n = 1;

1640

                let mut r = base;

1641

1642

                // Optimization for 128 bit wide integers.

1643

                if Self::BITS == 128 {

1644

                    // The following is a correct lower bound for ⌊log(base,self)⌋ because

1645

//

1646

                    // log(base,self) = log(2,self) / log(2,base)

1647

                    //                ≥ ⌊log(2,self)⌋ / (⌊log(2,base)⌋ + 1)

1648

//

1649

                    // hence

1650

//

1651

                    // ⌊log(base,self)⌋ ≥ ⌊ ⌊log(2,self)⌋ / (⌊log(2,base)⌋ + 1) ⌋ .

1652

                    n = self.ilog2() / (base.ilog2() + 1);

1653

                    r = base.pow(n);

1654

1655

1656

                while r <= self / base {

1657

                    n += 1;

1658

                    r *= base;

1659

1660

                Some(n)

1661

1662

1663

1664

        /// Returns the base 2 logarithm of the number, rounded down.

1665

///

1666

        /// Returns `None` if the number is zero.

1667

///

1668

        /// # Examples

1669

///

1670

        /// ```

1671

        #[doc = concat!("assert_eq!(2", stringify!($SelfT), ".checked_ilog2(), Some(1));")]

1672

        /// ```

1673

        #[stable(feature = "int_log", since = "1.67.0")]

1674

        #[rustc_const_stable(feature = "int_log", since = "1.67.0")]

1675

        #[must_use = "this returns the result of the operation, \

1676

                      without modifying the original"]

1677

        #[inline]

1678

        #[cfg(not(feature = "ferrocene_certified"))]

1679

        pub const fn checked_ilog2(self) -> Option<u32> {

1680

            match NonZero::new(self) {

1681

                Some(x) => Some(x.ilog2()),

1682

                None => None,

1683

1684

1685

1686

        /// Returns the base 10 logarithm of the number, rounded down.

1687

///

1688

        /// Returns `None` if the number is zero.

1689

///

1690

        /// # Examples

1691

///

1692

        /// ```

1693

        #[doc = concat!("assert_eq!(10", stringify!($SelfT), ".checked_ilog10(), Some(1));")]

1694

        /// ```

1695

        #[stable(feature = "int_log", since = "1.67.0")]

1696

        #[rustc_const_stable(feature = "int_log", since = "1.67.0")]

1697

        #[must_use = "this returns the result of the operation, \

1698

                      without modifying the original"]

1699

        #[inline]

1700

        #[cfg(not(feature = "ferrocene_certified"))]

1701

        pub const fn checked_ilog10(self) -> Option<u32> {

1702

            match NonZero::new(self) {

1703

                Some(x) => Some(x.ilog10()),

1704

                None => None,

1705

1706

1707

1708

        /// Checked negation. Computes `-self`, returning `None` unless `self ==

1709

        /// 0`.

1710

///

1711

        /// Note that negating any positive integer will overflow.

1712

///

1713

        /// # Examples

1714

///

1715

        /// ```

1716

        #[doc = concat!("assert_eq!(0", stringify!($SelfT), ".checked_neg(), Some(0));")]

1717

        #[doc = concat!("assert_eq!(1", stringify!($SelfT), ".checked_neg(), None);")]

1718

        /// ```

1719

        #[stable(feature = "wrapping", since = "1.7.0")]

1720

        #[rustc_const_stable(feature = "const_checked_int_methods", since = "1.47.0")]

1721

        #[must_use = "this returns the result of the operation, \

1722

                      without modifying the original"]

1723

        #[inline]

1724

        #[cfg(not(feature = "ferrocene_certified"))]

1725

        pub const fn checked_neg(self) -> Option<Self> {

1726

            let (a, b) = self.overflowing_neg();

1727

            if intrinsics::unlikely(b) { None } else { Some(a) }

1728

1729

1730

        /// Strict negation. Computes `-self`, panicking unless `self ==

1731

        /// 0`.

1732

///

1733

        /// Note that negating any positive integer will overflow.

1734

///

1735

        /// # Panics

1736

///

1737

        /// ## Overflow behavior

1738

///

1739

        /// This function will always panic on overflow, regardless of whether overflow checks are enabled.

1740

///

1741

        /// # Examples

1742

///

1743

        /// ```

1744

        #[doc = concat!("assert_eq!(0", stringify!($SelfT), ".strict_neg(), 0);")]

1745

        /// ```

1746

///

1747

        /// The following panics because of overflow:

1748

///

1749

        /// ```should_panic

1750

        #[doc = concat!("let _ = 1", stringify!($SelfT), ".strict_neg();")]

1751

        /// ```

1752

        #[stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

1753

        #[rustc_const_stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

1754

        #[must_use = "this returns the result of the operation, \

1755

                      without modifying the original"]

1756

        #[inline]

1757

        #[track_caller]

1758

        #[cfg(not(feature = "ferrocene_certified"))]

1759

        pub const fn strict_neg(self) -> Self {

1760

            let (a, b) = self.overflowing_neg();

1761

            if b { overflow_panic::neg() } else { a }

1762

1763

1764

        /// Checked shift left. Computes `self << rhs`, returning `None`

1765

        /// if `rhs` is larger than or equal to the number of bits in `self`.

1766

///

1767

        /// # Examples

1768

///

1769

        /// ```

1770

        #[doc = concat!("assert_eq!(0x1", stringify!($SelfT), ".checked_shl(4), Some(0x10));")]

1771

        #[doc = concat!("assert_eq!(0x10", stringify!($SelfT), ".checked_shl(129), None);")]

1772

        #[doc = concat!("assert_eq!(0x10", stringify!($SelfT), ".checked_shl(", stringify!($BITS_MINUS_ONE), "), Some(0));")]

1773

        /// ```

1774

        #[stable(feature = "wrapping", since = "1.7.0")]

1775

        #[rustc_const_stable(feature = "const_checked_int_methods", since = "1.47.0")]

1776

        #[must_use = "this returns the result of the operation, \

1777

                      without modifying the original"]

1778

        #[inline]

1779

        #[cfg(not(feature = "ferrocene_certified"))]

1780

        pub const fn checked_shl(self, rhs: u32) -> Option<Self> {

1781

            // Not using overflowing_shl as that's a wrapping shift

1782

            if rhs < Self::BITS {

1783

                // SAFETY: just checked the RHS is in-range

1784

                Some(unsafe { self.unchecked_shl(rhs) })

1785

            } else {

1786

                None

1787

1788

1789

1790

        /// Strict shift left. Computes `self << rhs`, panicking if `rhs` is larger

1791

        /// than or equal to the number of bits in `self`.

1792

///

1793

        /// # Panics

1794

///

1795

        /// ## Overflow behavior

1796

///

1797

        /// This function will always panic on overflow, regardless of whether overflow checks are enabled.

1798

///

1799

        /// # Examples

1800

///

1801

        /// ```

1802

        #[doc = concat!("assert_eq!(0x1", stringify!($SelfT), ".strict_shl(4), 0x10);")]

1803

        /// ```

1804

///

1805

        /// The following panics because of overflow:

1806

///

1807

        /// ```should_panic

1808

        #[doc = concat!("let _ = 0x10", stringify!($SelfT), ".strict_shl(129);")]

1809

        /// ```

1810

        #[stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

1811

        #[rustc_const_stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

1812

        #[must_use = "this returns the result of the operation, \

1813

                      without modifying the original"]

1814

        #[inline]

1815

        #[track_caller]

1816

        #[cfg(not(feature = "ferrocene_certified"))]

1817

        pub const fn strict_shl(self, rhs: u32) -> Self {

1818

            let (a, b) = self.overflowing_shl(rhs);

1819

            if b { overflow_panic::shl() } else { a }

1820

1821

1822

        /// Unchecked shift left. Computes `self << rhs`, assuming that

1823

        /// `rhs` is less than the number of bits in `self`.

1824

///

1825

        /// # Safety

1826

///

1827

        /// This results in undefined behavior if `rhs` is larger than

1828

        /// or equal to the number of bits in `self`,

1829

        /// i.e. when [`checked_shl`] would return `None`.

1830

///

1831

        #[doc = concat!("[`checked_shl`]: ", stringify!($SelfT), "::checked_shl")]

1832

        #[unstable(

1833

            feature = "unchecked_shifts",

1834

            reason = "niche optimization path",

1835

            issue = "85122",

1836

)]

1837

        #[must_use = "this returns the result of the operation, \

1838

                      without modifying the original"]

1839

        #[inline(always)]

1840

        #[track_caller]

1841

        #[cfg(not(feature = "ferrocene_certified"))]

1842

        pub const unsafe fn unchecked_shl(self, rhs: u32) -> Self {

1843

            assert_unsafe_precondition!(

1844

                check_language_ub,

1845

                concat!(stringify!($SelfT), "::unchecked_shl cannot overflow"),

1846

1847

                    rhs: u32 = rhs,

1848

                ) => rhs < <$ActualT>::BITS,

1849

);

1850

1851

            // SAFETY: this is guaranteed to be safe by the caller.

1852

            unsafe {

1853

                intrinsics::unchecked_shl(self, rhs)

1854

1855

1856

1857

        /// Unbounded shift left. Computes `self << rhs`, without bounding the value of `rhs`.

1858

///

1859

        /// If `rhs` is larger or equal to the number of bits in `self`,

1860

        /// the entire value is shifted out, and `0` is returned.

1861

///

1862

        /// # Examples

1863

///

1864

        /// ```

1865

        #[doc = concat!("assert_eq!(0x1", stringify!($SelfT), ".unbounded_shl(4), 0x10);")]

1866

        #[doc = concat!("assert_eq!(0x1", stringify!($SelfT), ".unbounded_shl(129), 0);")]

1867

        /// ```

1868

        #[stable(feature = "unbounded_shifts", since = "1.87.0")]

1869

        #[rustc_const_stable(feature = "unbounded_shifts", since = "1.87.0")]

1870

        #[must_use = "this returns the result of the operation, \

1871

                      without modifying the original"]

1872

        #[inline]

1873

        #[cfg(not(feature = "ferrocene_certified"))]

1874

        pub const fn unbounded_shl(self, rhs: u32) -> $SelfT{

1875

            if rhs < Self::BITS {

1876

                // SAFETY:

1877

                // rhs is just checked to be in-range above

1878

                unsafe { self.unchecked_shl(rhs) }

1879

            } else {

1880

1881

1882

1883

1884

        /// Checked shift right. Computes `self >> rhs`, returning `None`

1885

        /// if `rhs` is larger than or equal to the number of bits in `self`.

1886

///

1887

        /// # Examples

1888

///

1889

        /// ```

1890

        #[doc = concat!("assert_eq!(0x10", stringify!($SelfT), ".checked_shr(4), Some(0x1));")]

1891

        #[doc = concat!("assert_eq!(0x10", stringify!($SelfT), ".checked_shr(129), None);")]

1892

        /// ```

1893

        #[stable(feature = "wrapping", since = "1.7.0")]

1894

        #[rustc_const_stable(feature = "const_checked_int_methods", since = "1.47.0")]

1895

        #[must_use = "this returns the result of the operation, \

1896

                      without modifying the original"]

1897

        #[inline]

1898

        #[cfg(not(feature = "ferrocene_certified"))]

1899

        pub const fn checked_shr(self, rhs: u32) -> Option<Self> {

1900

            // Not using overflowing_shr as that's a wrapping shift

1901

            if rhs < Self::BITS {

1902

                // SAFETY: just checked the RHS is in-range

1903

                Some(unsafe { self.unchecked_shr(rhs) })

1904

            } else {

1905

                None

1906

1907

1908

1909

        /// Strict shift right. Computes `self >> rhs`, panicking `rhs` is

1910

        /// larger than or equal to the number of bits in `self`.

1911

///

1912

        /// # Panics

1913

///

1914

        /// ## Overflow behavior

1915

///

1916

        /// This function will always panic on overflow, regardless of whether overflow checks are enabled.

1917

///

1918

        /// # Examples

1919

///

1920

        /// ```

1921

        #[doc = concat!("assert_eq!(0x10", stringify!($SelfT), ".strict_shr(4), 0x1);")]

1922

        /// ```

1923

///

1924

        /// The following panics because of overflow:

1925

///

1926

        /// ```should_panic

1927

        #[doc = concat!("let _ = 0x10", stringify!($SelfT), ".strict_shr(129);")]

1928

        /// ```

1929

        #[stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

1930

        #[rustc_const_stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

1931

        #[must_use = "this returns the result of the operation, \

1932

                      without modifying the original"]

1933

        #[inline]

1934

        #[track_caller]

1935

        #[cfg(not(feature = "ferrocene_certified"))]

1936

        pub const fn strict_shr(self, rhs: u32) -> Self {

1937

            let (a, b) = self.overflowing_shr(rhs);

1938

            if b { overflow_panic::shr() } else { a }

1939

1940

1941

        /// Unchecked shift right. Computes `self >> rhs`, assuming that

1942

        /// `rhs` is less than the number of bits in `self`.

1943

///

1944

        /// # Safety

1945

///

1946

        /// This results in undefined behavior if `rhs` is larger than

1947

        /// or equal to the number of bits in `self`,

1948

        /// i.e. when [`checked_shr`] would return `None`.

1949

///

1950

        #[doc = concat!("[`checked_shr`]: ", stringify!($SelfT), "::checked_shr")]

1951

        #[unstable(

1952

            feature = "unchecked_shifts",

1953

            reason = "niche optimization path",

1954

            issue = "85122",

1955

)]

1956

        #[must_use = "this returns the result of the operation, \

1957

                      without modifying the original"]

1958

        #[inline(always)]

1959

        #[track_caller]

1960

        #[cfg(not(feature = "ferrocene_certified"))]

1961

        pub const unsafe fn unchecked_shr(self, rhs: u32) -> Self {

1962

            assert_unsafe_precondition!(

1963

                check_language_ub,

1964

                concat!(stringify!($SelfT), "::unchecked_shr cannot overflow"),

1965

1966

                    rhs: u32 = rhs,

1967

                ) => rhs < <$ActualT>::BITS,

1968

);

1969

1970

            // SAFETY: this is guaranteed to be safe by the caller.

1971

            unsafe {

1972

                intrinsics::unchecked_shr(self, rhs)

1973

1974

1975

1976

        /// Unbounded shift right. Computes `self >> rhs`, without bounding the value of `rhs`.

1977

///

1978

        /// If `rhs` is larger or equal to the number of bits in `self`,

1979

        /// the entire value is shifted out, and `0` is returned.

1980

///

1981

        /// # Examples

1982

///

1983

        /// ```

1984

        #[doc = concat!("assert_eq!(0x10", stringify!($SelfT), ".unbounded_shr(4), 0x1);")]

1985

        #[doc = concat!("assert_eq!(0x10", stringify!($SelfT), ".unbounded_shr(129), 0);")]

1986

        /// ```

1987

        #[stable(feature = "unbounded_shifts", since = "1.87.0")]

1988

        #[rustc_const_stable(feature = "unbounded_shifts", since = "1.87.0")]

1989

        #[must_use = "this returns the result of the operation, \

1990

                      without modifying the original"]

1991

        #[inline]

1992

        #[cfg(not(feature = "ferrocene_certified"))]

1993

        pub const fn unbounded_shr(self, rhs: u32) -> $SelfT{

1994

            if rhs < Self::BITS {

1995

                // SAFETY:

1996

                // rhs is just checked to be in-range above

1997

                unsafe { self.unchecked_shr(rhs) }

1998

            } else {

1999

2000

2001

2002

2003

        /// Checked exponentiation. Computes `self.pow(exp)`, returning `None` if

2004

        /// overflow occurred.

2005

///

2006

        /// # Examples

2007

///

2008

        /// ```

2009

        #[doc = concat!("assert_eq!(2", stringify!($SelfT), ".checked_pow(5), Some(32));")]

2010

        #[doc = concat!("assert_eq!(", stringify!($SelfT), "::MAX.checked_pow(2), None);")]

2011

        /// ```

2012

        #[stable(feature = "no_panic_pow", since = "1.34.0")]

2013

        #[rustc_const_stable(feature = "const_int_pow", since = "1.50.0")]

2014

        #[must_use = "this returns the result of the operation, \

2015

                      without modifying the original"]

2016

        #[inline]

2017

        #[cfg(not(feature = "ferrocene_certified"))]

2018

        pub const fn checked_pow(self, mut exp: u32) -> Option<Self> {

2019

            if exp == 0 {

2020

                return Some(1);

2021

2022

            let mut base = self;

2023

            let mut acc: Self = 1;

2024

2025

            loop {

2026

                if (exp & 1) == 1 {

2027

                    acc = try_opt!(acc.checked_mul(base));

2028

                    // since exp!=0, finally the exp must be 1.

2029

                    if exp == 1 {

2030

                        return Some(acc);

2031

2032

2033

                exp /= 2;

2034

                base = try_opt!(base.checked_mul(base));

2035

2036

2037

2038

        /// Strict exponentiation. Computes `self.pow(exp)`, panicking if

2039

        /// overflow occurred.

2040

///

2041

        /// # Panics

2042

///

2043

        /// ## Overflow behavior

2044

///

2045

        /// This function will always panic on overflow, regardless of whether overflow checks are enabled.

2046

///

2047

        /// # Examples

2048

///

2049

        /// ```

2050

        #[doc = concat!("assert_eq!(2", stringify!($SelfT), ".strict_pow(5), 32);")]

2051

        /// ```

2052

///

2053

        /// The following panics because of overflow:

2054

///

2055

        /// ```should_panic

2056

        #[doc = concat!("let _ = ", stringify!($SelfT), "::MAX.strict_pow(2);")]

2057

        /// ```

2058

        #[stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

2059

        #[rustc_const_stable(feature = "strict_overflow_ops", since = "CURRENT_RUSTC_VERSION")]

2060

        #[must_use = "this returns the result of the operation, \

2061

                      without modifying the original"]

2062

        #[inline]

2063

        #[track_caller]

2064

        #[cfg(not(feature = "ferrocene_certified"))]

2065

        pub const fn strict_pow(self, mut exp: u32) -> Self {

2066

            if exp == 0 {

2067

                return 1;

2068

2069

            let mut base = self;

2070

            let mut acc: Self = 1;

2071

2072

            loop {

2073

                if (exp & 1) == 1 {

2074

                    acc = acc.strict_mul(base);

2075

                    // since exp!=0, finally the exp must be 1.

2076

                    if exp == 1 {

2077

                        return acc;

2078

2079

2080

                exp /= 2;

2081

                base = base.strict_mul(base);

2082

2083

2084

2085

        /// Saturating integer addition. Computes `self + rhs`, saturating at

2086

        /// the numeric bounds instead of overflowing.

2087

///

2088

        /// # Examples

2089

///

2090

        /// ```

2091

        #[doc = concat!("assert_eq!(100", stringify!($SelfT), ".saturating_add(1), 101);")]

2092

        #[doc = concat!("assert_eq!(", stringify!($SelfT), "::MAX.saturating_add(127), ", stringify!($SelfT), "::MAX);")]

2093

        /// ```

2094

        #[stable(feature = "rust1", since = "1.0.0")]

2095

        #[must_use = "this returns the result of the operation, \

2096

                      without modifying the original"]

2097

        #[rustc_const_stable(feature = "const_saturating_int_methods", since = "1.47.0")]

2098

        #[inline(always)]

2099

        #[cfg(not(feature = "ferrocene_certified"))]

2100

        pub const fn saturating_add(self, rhs: Self) -> Self {

2101

            intrinsics::saturating_add(self, rhs)

2102

2103

2104

        /// Saturating addition with a signed integer. Computes `self + rhs`,

2105

        /// saturating at the numeric bounds instead of overflowing.

2106

///

2107

        /// # Examples

2108

///

2109

        /// ```

2110

        #[doc = concat!("assert_eq!(1", stringify!($SelfT), ".saturating_add_signed(2), 3);")]

2111

        #[doc = concat!("assert_eq!(1", stringify!($SelfT), ".saturating_add_signed(-2), 0);")]

2112

        #[doc = concat!("assert_eq!((", stringify!($SelfT), "::MAX - 2).saturating_add_signed(4), ", stringify!($SelfT), "::MAX);")]

2113

        /// ```

2114

        #[stable(feature = "mixed_integer_ops", since = "1.66.0")]

2115

        #[rustc_const_stable(feature = "mixed_integer_ops", since = "1.66.0")]

2116

        #[must_use = "this returns the result of the operation, \

2117

                      without modifying the original"]

2118

        #[inline]

2119

        #[cfg(not(feature = "ferrocene_certified"))]

2120

        pub const fn saturating_add_signed(self, rhs: $SignedT) -> Self {

2121

            let (res, overflow) = self.overflowing_add(rhs as Self);

2122

            if overflow == (rhs < 0) {

2123

res

2124

            } else if overflow {

2125

                Self::MAX

2126

            } else {

2127

2128

2129

2130

2131

        /// Saturating integer subtraction. Computes `self - rhs`, saturating

2132

        /// at the numeric bounds instead of overflowing.

2133

///

2134

        /// # Examples

2135

///

2136

        /// ```

2137

        #[doc = concat!("assert_eq!(100", stringify!($SelfT), ".saturating_sub(27), 73);")]

2138

        #[doc = concat!("assert_eq!(13", stringify!($SelfT), ".saturating_sub(127), 0);")]

2139

        /// ```

2140

        #[stable(feature = "rust1", since = "1.0.0")]

2141

        #[must_use = "this returns the result of the operation, \

2142

                      without modifying the original"]

2143

        #[rustc_const_stable(feature = "const_saturating_int_methods", since = "1.47.0")]

2144

        #[inline(always)]

2145

        #[cfg(not(feature = "ferrocene_certified"))]

2146

        pub const fn saturating_sub(self, rhs: Self) -> Self {

2147

            intrinsics::saturating_sub(self, rhs)

2148

2149

2150

        /// Saturating integer subtraction. Computes `self` - `rhs`, saturating at

2151

        /// the numeric bounds instead of overflowing.

2152

///

2153

        /// # Examples

2154

///

2155

        /// ```

2156

        #[doc = concat!("assert_eq!(1", stringify!($SelfT), ".saturating_sub_signed(2), 0);")]

2157

        #[doc = concat!("assert_eq!(1", stringify!($SelfT), ".saturating_sub_signed(-2), 3);")]

2158

        #[doc = concat!("assert_eq!((", stringify!($SelfT), "::MAX - 2).saturating_sub_signed(-4), ", stringify!($SelfT), "::MAX);")]

2159

        /// ```

2160

        #[stable(feature = "mixed_integer_ops_unsigned_sub", since = "1.90.0")]

2161

        #[rustc_const_stable(feature = "mixed_integer_ops_unsigned_sub", since = "1.90.0")]

2162

        #[must_use = "this returns the result of the operation, \

2163

                      without modifying the original"]

2164

        #[inline]

2165

        #[cfg(not(feature = "ferrocene_certified"))]

2166

        pub const fn saturating_sub_signed(self, rhs: $SignedT) -> Self {

2167

            let (res, overflow) = self.overflowing_sub_signed(rhs);

2168

2169

            if !overflow {

2170

res

2171

            } else if rhs < 0 {

2172

                Self::MAX

2173

            } else {

2174

2175

2176

2177

2178

        /// Saturating integer multiplication. Computes `self * rhs`,

2179

        /// saturating at the numeric bounds instead of overflowing.

2180

///

2181

        /// # Examples

2182

///

2183

        /// ```

2184

        #[doc = concat!("assert_eq!(2", stringify!($SelfT), ".saturating_mul(10), 20);")]

2185

        #[doc = concat!("assert_eq!((", stringify!($SelfT), "::MAX).saturating_mul(10), ", stringify!($SelfT),"::MAX);")]

2186

        /// ```

2187

        #[stable(feature = "wrapping", since = "1.7.0")]

2188

        #[rustc_const_stable(feature = "const_saturating_int_methods", since = "1.47.0")]

2189

        #[must_use = "this returns the result of the operation, \

2190

                      without modifying the original"]

2191

        #[inline]

2192

        #[cfg(not(feature = "ferrocene_certified"))]

2193

        pub const fn saturating_mul(self, rhs: Self) -> Self {

2194

            match self.checked_mul(rhs) {

2195

                Some(x) => x,

2196

                None => Self::MAX,

2197

2198

2199

2200

        /// Saturating integer division. Computes `self / rhs`, saturating at the

2201

        /// numeric bounds instead of overflowing.

2202

///

2203

        /// # Panics

2204

///

2205

        /// This function will panic if `rhs` is zero.

2206

///

2207

        /// # Examples

2208

///

2209

        /// ```

2210

        #[doc = concat!("assert_eq!(5", stringify!($SelfT), ".saturating_div(2), 2);")]

2211

///

2212

        /// ```

2213

        #[stable(feature = "saturating_div", since = "1.58.0")]

2214

        #[rustc_const_stable(feature = "saturating_div", since = "1.58.0")]

2215

        #[must_use = "this returns the result of the operation, \

2216

                      without modifying the original"]

2217

        #[inline]

2218

        #[track_caller]

2219

        #[cfg(not(feature = "ferrocene_certified"))]

2220

        pub const fn saturating_div(self, rhs: Self) -> Self {

2221

            // on unsigned types, there is no overflow in integer division

2222

            self.wrapping_div(rhs)

2223

2224

2225

        /// Saturating integer exponentiation. Computes `self.pow(exp)`,

2226

        /// saturating at the numeric bounds instead of overflowing.

2227

///

2228

        /// # Examples

2229

///

2230

        /// ```

2231

        #[doc = concat!("assert_eq!(4", stringify!($SelfT), ".saturating_pow(3), 64);")]

2232

        #[doc = concat!("assert_eq!(", stringify!($SelfT), "::MAX.saturating_pow(2), ", stringify!($SelfT), "::MAX);")]

2233

        /// ```

2234

        #[stable(feature = "no_panic_pow", since = "1.34.0")]

2235

        #[rustc_const_stable(feature = "const_int_pow", since = "1.50.0")]

2236

        #[must_use = "this returns the result of the operation, \

2237

                      without modifying the original"]

2238

        #[inline]

2239

        #[cfg(not(feature = "ferrocene_certified"))]

2240

        pub const fn saturating_pow(self, exp: u32) -> Self {

2241

            match self.checked_pow(exp) {

2242

                Some(x) => x,

2243

                None => Self::MAX,

2244

2245

2246

2247

        /// Wrapping (modular) addition. Computes `self + rhs`,

2248

        /// wrapping around at the boundary of the type.

2249

///

2250

        /// # Examples

2251

///

2252

        /// ```

2253

        #[doc = concat!("assert_eq!(200", stringify!($SelfT), ".wrapping_add(55), 255);")]

2254

        #[doc = concat!("assert_eq!(200", stringify!($SelfT), ".wrapping_add(", stringify!($SelfT), "::MAX), 199);")]

2255

        /// ```

2256

        #[stable(feature = "rust1", since = "1.0.0")]

2257

        #[rustc_const_stable(feature = "const_wrapping_math", since = "1.32.0")]

2258

        #[must_use = "this returns the result of the operation, \

2259

                      without modifying the original"]

2260

        #[inline(always)]

2261

        #[cfg(not(feature = "ferrocene_certified"))]

2262

        pub const fn wrapping_add(self, rhs: Self) -> Self {

2263

            intrinsics::wrapping_add(self, rhs)

2264

2265

2266

        /// Wrapping (modular) addition with a signed integer. Computes

2267

        /// `self + rhs`, wrapping around at the boundary of the type.

2268

///

2269

        /// # Examples

2270

///

2271

        /// ```

2272

        #[doc = concat!("assert_eq!(1", stringify!($SelfT), ".wrapping_add_signed(2), 3);")]

2273

        #[doc = concat!("assert_eq!(1", stringify!($SelfT), ".wrapping_add_signed(-2), ", stringify!($SelfT), "::MAX);")]

2274

        #[doc = concat!("assert_eq!((", stringify!($SelfT), "::MAX - 2).wrapping_add_signed(4), 1);")]

2275

        /// ```

2276

        #[stable(feature = "mixed_integer_ops", since = "1.66.0")]

2277

        #[rustc_const_stable(feature = "mixed_integer_ops", since = "1.66.0")]

2278

        #[must_use = "this returns the result of the operation, \

2279

                      without modifying the original"]

2280

        #[inline]

2281

        #[cfg(not(feature = "ferrocene_certified"))]

2282

        pub const fn wrapping_add_signed(self, rhs: $SignedT) -> Self {

2283

            self.wrapping_add(rhs as Self)

2284

2285

2286

        /// Wrapping (modular) subtraction. Computes `self - rhs`,

2287

        /// wrapping around at the boundary of the type.

2288

///

2289

        /// # Examples

2290

///

2291

        /// ```

2292

        #[doc = concat!("assert_eq!(100", stringify!($SelfT), ".wrapping_sub(100), 0);")]

2293

        #[doc = concat!("assert_eq!(100", stringify!($SelfT), ".wrapping_sub(", stringify!($SelfT), "::MAX), 101);")]

2294

        /// ```

2295

        #[stable(feature = "rust1", since = "1.0.0")]

2296

        #[rustc_const_stable(feature = "const_wrapping_math", since = "1.32.0")]

2297

        #[must_use = "this returns the result of the operation, \

2298

                      without modifying the original"]

2299

        #[inline(always)]

2300

        #[cfg(not(feature = "ferrocene_certified"))]

2301

        pub const fn wrapping_sub(self, rhs: Self) -> Self {

2302

            intrinsics::wrapping_sub(self, rhs)

2303

2304

2305

        /// Wrapping (modular) subtraction with a signed integer. Computes

2306

        /// `self - rhs`, wrapping around at the boundary of the type.

2307

///

2308

        /// # Examples

2309

///

2310

        /// ```

2311

        #[doc = concat!("assert_eq!(1", stringify!($SelfT), ".wrapping_sub_signed(2), ", stringify!($SelfT), "::MAX);")]

2312

        #[doc = concat!("assert_eq!(1", stringify!($SelfT), ".wrapping_sub_signed(-2), 3);")]

2313

        #[doc = concat!("assert_eq!((", stringify!($SelfT), "::MAX - 2).wrapping_sub_signed(-4), 1);")]

2314

        /// ```

2315

        #[stable(feature = "mixed_integer_ops_unsigned_sub", since = "1.90.0")]

2316

        #[rustc_const_stable(feature = "mixed_integer_ops_unsigned_sub", since = "1.90.0")]

2317

        #[must_use = "this returns the result of the operation, \

2318

                      without modifying the original"]

2319

        #[inline]

2320

        #[cfg(not(feature = "ferrocene_certified"))]

2321

        pub const fn wrapping_sub_signed(self, rhs: $SignedT) -> Self {

2322

            self.wrapping_sub(rhs as Self)

2323

2324

2325

        /// Wrapping (modular) multiplication. Computes `self *

2326

        /// rhs`, wrapping around at the boundary of the type.

2327

///

2328

        /// # Examples

2329

///

2330

        /// Please note that this example is shared among integer types, which is why `u8` is used.

2331

///

2332

        /// ```

2333

        /// assert_eq!(10u8.wrapping_mul(12), 120);

2334

        /// assert_eq!(25u8.wrapping_mul(12), 44);

2335

        /// ```

2336

        #[stable(feature = "rust1", since = "1.0.0")]

2337

        #[rustc_const_stable(feature = "const_wrapping_math", since = "1.32.0")]

2338

        #[must_use = "this returns the result of the operation, \

2339

                      without modifying the original"]

2340

        #[inline(always)]

2341

        #[cfg(not(feature = "ferrocene_certified"))]

2342

        pub const fn wrapping_mul(self, rhs: Self) -> Self {

2343

            intrinsics::wrapping_mul(self, rhs)

2344

2345

2346

        /// Wrapping (modular) division. Computes `self / rhs`.

2347

///

2348

        /// Wrapped division on unsigned types is just normal division. There's

2349

        /// no way wrapping could ever happen. This function exists so that all

2350

        /// operations are accounted for in the wrapping operations.

2351

///

2352

        /// # Panics

2353

///

2354

        /// This function will panic if `rhs` is zero.

2355

///

2356

        /// # Examples

2357

///

2358

        /// ```

2359

        #[doc = concat!("assert_eq!(100", stringify!($SelfT), ".wrapping_div(10), 10);")]

2360

        /// ```

2361

        #[stable(feature = "num_wrapping", since = "1.2.0")]

2362

        #[rustc_const_stable(feature = "const_wrapping_int_methods", since = "1.52.0")]

2363

        #[must_use = "this returns the result of the operation, \

2364

                      without modifying the original"]

2365

        #[inline(always)]

2366

        #[track_caller]

2367

        #[cfg(not(feature = "ferrocene_certified"))]

2368

        pub const fn wrapping_div(self, rhs: Self) -> Self {

2369

            self / rhs

2370

2371

2372

        /// Wrapping Euclidean division. Computes `self.div_euclid(rhs)`.

2373

///

2374

        /// Wrapped division on unsigned types is just normal division. There's

2375

        /// no way wrapping could ever happen. This function exists so that all

2376

        /// operations are accounted for in the wrapping operations. Since, for

2377

        /// the positive integers, all common definitions of division are equal,

2378

        /// this is exactly equal to `self.wrapping_div(rhs)`.

2379

///

2380

        /// # Panics

2381

///

2382

        /// This function will panic if `rhs` is zero.

2383

///

2384

        /// # Examples

2385

///

2386

        /// ```

2387

        #[doc = concat!("assert_eq!(100", stringify!($SelfT), ".wrapping_div_euclid(10), 10);")]

2388

        /// ```

2389

        #[stable(feature = "euclidean_division", since = "1.38.0")]

2390

        #[rustc_const_stable(feature = "const_euclidean_int_methods", since = "1.52.0")]

2391

        #[must_use = "this returns the result of the operation, \

2392

                      without modifying the original"]

2393

        #[inline(always)]

2394

        #[track_caller]

2395

        #[cfg(not(feature = "ferrocene_certified"))]

2396

        pub const fn wrapping_div_euclid(self, rhs: Self) -> Self {

2397

            self / rhs

2398

2399

2400

        /// Wrapping (modular) remainder. Computes `self % rhs`.

2401

///

2402

        /// Wrapped remainder calculation on unsigned types is just the regular

2403

        /// remainder calculation. There's no way wrapping could ever happen.

2404

        /// This function exists so that all operations are accounted for in the

2405

        /// wrapping operations.

2406

///

2407

        /// # Panics

2408

///

2409

        /// This function will panic if `rhs` is zero.

2410

///

2411

        /// # Examples

2412

///

2413

        /// ```

2414

        #[doc = concat!("assert_eq!(100", stringify!($SelfT), ".wrapping_rem(10), 0);")]

2415

        /// ```

2416

        #[stable(feature = "num_wrapping", since = "1.2.0")]

2417

        #[rustc_const_stable(feature = "const_wrapping_int_methods", since = "1.52.0")]

2418

        #[must_use = "this returns the result of the operation, \

2419

                      without modifying the original"]

2420

        #[inline(always)]

2421

        #[track_caller]

2422

        #[cfg(not(feature = "ferrocene_certified"))]

2423

        pub const fn wrapping_rem(self, rhs: Self) -> Self {

2424

            self % rhs

2425

2426

2427

        /// Wrapping Euclidean modulo. Computes `self.rem_euclid(rhs)`.

2428

///

2429

        /// Wrapped modulo calculation on unsigned types is just the regular

2430

        /// remainder calculation. There's no way wrapping could ever happen.

2431

        /// This function exists so that all operations are accounted for in the

2432

        /// wrapping operations. Since, for the positive integers, all common

2433

        /// definitions of division are equal, this is exactly equal to

2434

        /// `self.wrapping_rem(rhs)`.

2435

///

2436

        /// # Panics

2437

///

2438

        /// This function will panic if `rhs` is zero.

2439

///

2440

        /// # Examples

2441

///

2442

        /// ```

2443

        #[doc = concat!("assert_eq!(100", stringify!($SelfT), ".wrapping_rem_euclid(10), 0);")]

2444

        /// ```

2445

        #[stable(feature = "euclidean_division", since = "1.38.0")]

2446

        #[rustc_const_stable(feature = "const_euclidean_int_methods", since = "1.52.0")]

2447

        #[must_use = "this returns the result of the operation, \

2448

                      without modifying the original"]

2449

        #[inline(always)]

2450

        #[track_caller]

2451

        #[cfg(not(feature = "ferrocene_certified"))]

2452

        pub const fn wrapping_rem_euclid(self, rhs: Self) -> Self {

2453

            self % rhs

2454

2455

2456

        /// Wrapping (modular) negation. Computes `-self`,

2457

        /// wrapping around at the boundary of the type.

2458

///

2459

        /// Since unsigned types do not have negative equivalents

2460

        /// all applications of this function will wrap (except for `-0`).

2461

        /// For values smaller than the corresponding signed type's maximum

2462

        /// the result is the same as casting the corresponding signed value.

2463

        /// Any larger values are equivalent to `MAX + 1 - (val - MAX - 1)` where

2464

        /// `MAX` is the corresponding signed type's maximum.

2465

///

2466

        /// # Examples

2467

///

2468

        /// ```

2469

        #[doc = concat!("assert_eq!(0_", stringify!($SelfT), ".wrapping_neg(), 0);")]

2470

        #[doc = concat!("assert_eq!(", stringify!($SelfT), "::MAX.wrapping_neg(), 1);")]

2471

        #[doc = concat!("assert_eq!(13_", stringify!($SelfT), ".wrapping_neg(), (!13) + 1);")]

2472

        #[doc = concat!("assert_eq!(42_", stringify!($SelfT), ".wrapping_neg(), !(42 - 1));")]

2473

        /// ```

2474

        #[stable(feature = "num_wrapping", since = "1.2.0")]

2475

        #[rustc_const_stable(feature = "const_wrapping_math", since = "1.32.0")]

2476

        #[must_use = "this returns the result of the operation, \

2477

                      without modifying the original"]

2478

        #[inline(always)]

2479

        #[cfg(not(feature = "ferrocene_certified"))]

2480

        pub const fn wrapping_neg(self) -> Self {

2481

            (0 as $SelfT).wrapping_sub(self)

2482

2483

2484

        /// Panic-free bitwise shift-left; yields `self << mask(rhs)`,

2485

        /// where `mask` removes any high-order bits of `rhs` that

2486

        /// would cause the shift to exceed the bitwidth of the type.

2487

///

2488

        /// Note that this is *not* the same as a rotate-left; the

2489

        /// RHS of a wrapping shift-left is restricted to the range

2490

        /// of the type, rather than the bits shifted out of the LHS

2491

        /// being returned to the other end. The primitive integer

2492

        /// types all implement a [`rotate_left`](Self::rotate_left) function,

2493

        /// which may be what you want instead.

2494

///

2495

        /// # Examples

2496

///

2497

        /// ```

2498

        #[doc = concat!("assert_eq!(1", stringify!($SelfT), ".wrapping_shl(7), 128);")]

2499

        #[doc = concat!("assert_eq!(1", stringify!($SelfT), ".wrapping_shl(128), 1);")]

2500

        /// ```

2501

        #[stable(feature = "num_wrapping", since = "1.2.0")]

2502

        #[rustc_const_stable(feature = "const_wrapping_math", since = "1.32.0")]

2503

        #[must_use = "this returns the result of the operation, \

2504

                      without modifying the original"]

2505

        #[inline(always)]

2506

        #[cfg(not(feature = "ferrocene_certified"))]

2507

        pub const fn wrapping_shl(self, rhs: u32) -> Self {

2508

            // SAFETY: the masking by the bitsize of the type ensures that we do not shift

2509

            // out of bounds

2510

            unsafe {

2511

                self.unchecked_shl(rhs & (Self::BITS - 1))

2512

2513

2514

2515

        /// Panic-free bitwise shift-right; yields `self >> mask(rhs)`,

2516

        /// where `mask` removes any high-order bits of `rhs` that

2517

        /// would cause the shift to exceed the bitwidth of the type.

2518

///

2519

        /// Note that this is *not* the same as a rotate-right; the

2520

        /// RHS of a wrapping shift-right is restricted to the range

2521

        /// of the type, rather than the bits shifted out of the LHS

2522

        /// being returned to the other end. The primitive integer

2523

        /// types all implement a [`rotate_right`](Self::rotate_right) function,

2524

        /// which may be what you want instead.

2525

///

2526

        /// # Examples

2527

///

2528

        /// ```

2529

        #[doc = concat!("assert_eq!(128", stringify!($SelfT), ".wrapping_shr(7), 1);")]

2530

        #[doc = concat!("assert_eq!(128", stringify!($SelfT), ".wrapping_shr(128), 128);")]

2531

        /// ```

2532

        #[stable(feature = "num_wrapping", since = "1.2.0")]

2533

        #[rustc_const_stable(feature = "const_wrapping_math", since = "1.32.0")]

2534

        #[must_use = "this returns the result of the operation, \

2535

                      without modifying the original"]

2536

        #[inline(always)]

2537

        #[cfg(not(feature = "ferrocene_certified"))]

2538

        pub const fn wrapping_shr(self, rhs: u32) -> Self {

2539

            // SAFETY: the masking by the bitsize of the type ensures that we do not shift

2540

            // out of bounds

2541

            unsafe {

2542

                self.unchecked_shr(rhs & (Self::BITS - 1))

2543

2544

2545

2546

        /// Wrapping (modular) exponentiation. Computes `self.pow(exp)`,

2547

        /// wrapping around at the boundary of the type.

2548

///

2549

        /// # Examples

2550

///

2551

        /// ```

2552

        #[doc = concat!("assert_eq!(3", stringify!($SelfT), ".wrapping_pow(5), 243);")]

2553

        /// assert_eq!(3u8.wrapping_pow(6), 217);

2554

        /// ```

2555

        #[stable(feature = "no_panic_pow", since = "1.34.0")]

2556

        #[rustc_const_stable(feature = "const_int_pow", since = "1.50.0")]

2557

        #[must_use = "this returns the result of the operation, \

2558

                      without modifying the original"]

2559

        #[inline]

2560

        #[cfg(not(feature = "ferrocene_certified"))]

2561

        pub const fn wrapping_pow(self, mut exp: u32) -> Self {

2562

            if exp == 0 {

2563

                return 1;

2564

2565

            let mut base = self;

2566

            let mut acc: Self = 1;

2567

2568

            if intrinsics::is_val_statically_known(exp) {

2569

                while exp > 1 {

2570

                    if (exp & 1) == 1 {

2571

                        acc = acc.wrapping_mul(base);

2572

2573

                    exp /= 2;

2574

                    base = base.wrapping_mul(base);

2575

2576

2577

                // since exp!=0, finally the exp must be 1.

2578

                // Deal with the final bit of the exponent separately, since

2579

                // squaring the base afterwards is not necessary.

2580

                acc.wrapping_mul(base)

2581

            } else {

2582

                // This is faster than the above when the exponent is not known

2583

                // at compile time. We can't use the same code for the constant

2584

                // exponent case because LLVM is currently unable to unroll

2585

                // this loop.

2586

                loop {

2587

                    if (exp & 1) == 1 {

2588

                        acc = acc.wrapping_mul(base);

2589

                        // since exp!=0, finally the exp must be 1.

2590

                        if exp == 1 {

2591

                            return acc;

2592

2593

2594

                    exp /= 2;

2595

                    base = base.wrapping_mul(base);

2596

2597

2598

2599

2600

        /// Calculates `self` + `rhs`.

2601

///

2602

        /// Returns a tuple of the addition along with a boolean indicating

2603

        /// whether an arithmetic overflow would occur. If an overflow would

2604

        /// have occurred then the wrapped value is returned.

2605

///

2606

        /// # Examples

2607

///

2608

        /// ```

2609

        #[doc = concat!("assert_eq!(5", stringify!($SelfT), ".overflowing_add(2), (7, false));")]

2610

        #[doc = concat!("assert_eq!(", stringify!($SelfT), "::MAX.overflowing_add(1), (0, true));")]

2611

        /// ```

2612

        #[stable(feature = "wrapping", since = "1.7.0")]

2613

        #[rustc_const_stable(feature = "const_wrapping_math", since = "1.32.0")]

2614

        #[must_use = "this returns the result of the operation, \

2615

                      without modifying the original"]

2616

        #[inline(always)]

2617

        #[cfg(not(feature = "ferrocene_certified"))]

2618

        pub const fn overflowing_add(self, rhs: Self) -> (Self, bool) {

2619

            let (a, b) = intrinsics::add_with_overflow(self as $ActualT, rhs as $ActualT);

2620

            (a as Self, b)

2621

2622

2623

        /// Calculates `self` + `rhs` + `carry` and returns a tuple containing

2624

        /// the sum and the output carry (in that order).

2625

///

2626

        /// Performs "ternary addition" of two integer operands and a carry-in

2627

        /// bit, and returns an output integer and a carry-out bit. This allows

2628

        /// chaining together multiple additions to create a wider addition, and

2629

        /// can be useful for bignum addition.

2630

///

2631

        #[doc = concat!("This can be thought of as a ", stringify!($BITS), "-bit \"full adder\", in the electronics sense.")]

2632

///

2633

        /// If the input carry is false, this method is equivalent to

2634

        /// [`overflowing_add`](Self::overflowing_add), and the output carry is

2635

        /// equal to the overflow flag. Note that although carry and overflow

2636

        /// flags are similar for unsigned integers, they are different for

2637

        /// signed integers.

2638

///

2639

        /// # Examples

2640

///

2641

        /// ```

2642

        #[doc = concat!("//    3  MAX    (a = 3 × 2^", stringify!($BITS), " + 2^", stringify!($BITS), " - 1)")]

2643

        #[doc = concat!("// +  5    7    (b = 5 × 2^", stringify!($BITS), " + 7)")]

2644

        /// // ---------

2645

        #[doc = concat!("//    9    6    (sum = 9 × 2^", stringify!($BITS), " + 6)")]

2646

///

2647

        #[doc = concat!("let (a1, a0): (", stringify!($SelfT), ", ", stringify!($SelfT), ") = (3, ", stringify!($SelfT), "::MAX);")]

2648

        #[doc = concat!("let (b1, b0): (", stringify!($SelfT), ", ", stringify!($SelfT), ") = (5, 7);")]

2649

        /// let carry0 = false;

2650

///

2651

        /// let (sum0, carry1) = a0.carrying_add(b0, carry0);

2652

        /// assert_eq!(carry1, true);

2653

        /// let (sum1, carry2) = a1.carrying_add(b1, carry1);

2654

        /// assert_eq!(carry2, false);

2655

///

2656

        /// assert_eq!((sum1, sum0), (9, 6));

2657

        /// ```

2658

        #[stable(feature = "unsigned_bigint_helpers", since = "CURRENT_RUSTC_VERSION")]

2659

        #[rustc_const_unstable(feature = "bigint_helper_methods", issue = "85532")]

2660

        #[must_use = "this returns the result of the operation, \

2661

                      without modifying the original"]

2662

        #[inline]

2663

        #[cfg(not(feature = "ferrocene_certified"))]

2664

        pub const fn carrying_add(self, rhs: Self, carry: bool) -> (Self, bool) {

2665

            // note: longer-term this should be done via an intrinsic, but this has been shown

2666

            //   to generate optimal code for now, and LLVM doesn't have an equivalent intrinsic

2667

            let (a, c1) = self.overflowing_add(rhs);

2668

            let (b, c2) = a.overflowing_add(carry as $SelfT);

2669

            // Ideally LLVM would know this is disjoint without us telling them,

2670

            // but it doesn't <https://github.com/llvm/llvm-project/issues/118162>

2671

            // SAFETY: Only one of `c1` and `c2` can be set.

2672

            // For c1 to be set we need to have overflowed, but if we did then

2673

            // `a` is at most `MAX-1`, which means that `c2` cannot possibly

2674

            // overflow because it's adding at most `1` (since it came from `bool`)

2675

            (b, unsafe { intrinsics::disjoint_bitor(c1, c2) })

2676

2677

2678

        /// Calculates `self` + `rhs` with a signed `rhs`.

2679

///

2680

        /// Returns a tuple of the addition along with a boolean indicating

2681

        /// whether an arithmetic overflow would occur. If an overflow would

2682

        /// have occurred then the wrapped value is returned.

2683

///

2684

        /// # Examples

2685

///

2686

        /// ```

2687

        #[doc = concat!("assert_eq!(1", stringify!($SelfT), ".overflowing_add_signed(2), (3, false));")]

2688

        #[doc = concat!("assert_eq!(1", stringify!($SelfT), ".overflowing_add_signed(-2), (", stringify!($SelfT), "::MAX, true));")]

2689

        #[doc = concat!("assert_eq!((", stringify!($SelfT), "::MAX - 2).overflowing_add_signed(4), (1, true));")]

2690

        /// ```

2691

        #[stable(feature = "mixed_integer_ops", since = "1.66.0")]

2692

        #[rustc_const_stable(feature = "mixed_integer_ops", since = "1.66.0")]

2693

        #[must_use = "this returns the result of the operation, \

2694

                      without modifying the original"]

2695

        #[inline]

2696

        #[cfg(not(feature = "ferrocene_certified"))]

2697

        pub const fn overflowing_add_signed(self, rhs: $SignedT) -> (Self, bool) {

2698

            let (res, overflowed) = self.overflowing_add(rhs as Self);

2699

            (res, overflowed ^ (rhs < 0))

2700

2701

2702

        /// Calculates `self` - `rhs`.

2703

///

2704

        /// Returns a tuple of the subtraction along with a boolean indicating

2705

        /// whether an arithmetic overflow would occur. If an overflow would

2706

        /// have occurred then the wrapped value is returned.

2707

///

2708

        /// # Examples

2709

///

2710

        /// ```

2711

        #[doc = concat!("assert_eq!(5", stringify!($SelfT), ".overflowing_sub(2), (3, false));")]

2712

        #[doc = concat!("assert_eq!(0", stringify!($SelfT), ".overflowing_sub(1), (", stringify!($SelfT), "::MAX, true));")]

2713

        /// ```

2714

        #[stable(feature = "wrapping", since = "1.7.0")]

2715

        #[rustc_const_stable(feature = "const_wrapping_math", since = "1.32.0")]

2716

        #[must_use = "this returns the result of the operation, \

2717

                      without modifying the original"]

2718

        #[inline(always)]

2719

        #[cfg(not(feature = "ferrocene_certified"))]

2720

        pub const fn overflowing_sub(self, rhs: Self) -> (Self, bool) {

2721

            let (a, b) = intrinsics::sub_with_overflow(self as $ActualT, rhs as $ActualT);

2722

            (a as Self, b)

2723

2724

2725

        /// Calculates `self` &minus; `rhs` &minus; `borrow` and returns a tuple

2726

        /// containing the difference and the output borrow.

2727

///

2728

        /// Performs "ternary subtraction" by subtracting both an integer

2729

        /// operand and a borrow-in bit from `self`, and returns an output

2730

        /// integer and a borrow-out bit. This allows chaining together multiple

2731

        /// subtractions to create a wider subtraction, and can be useful for

2732

        /// bignum subtraction.

2733

///

2734

        /// # Examples

2735

///

2736

        /// ```

2737

        #[doc = concat!("//    9    6    (a = 9 × 2^", stringify!($BITS), " + 6)")]

2738

        #[doc = concat!("// -  5    7    (b = 5 × 2^", stringify!($BITS), " + 7)")]

2739

        /// // ---------

2740

        #[doc = concat!("//    3  MAX    (diff = 3 × 2^", stringify!($BITS), " + 2^", stringify!($BITS), " - 1)")]

2741

///

2742

        #[doc = concat!("let (a1, a0): (", stringify!($SelfT), ", ", stringify!($SelfT), ") = (9, 6);")]

2743

        #[doc = concat!("let (b1, b0): (", stringify!($SelfT), ", ", stringify!($SelfT), ") = (5, 7);")]

2744

        /// let borrow0 = false;

2745

///

2746

        /// let (diff0, borrow1) = a0.borrowing_sub(b0, borrow0);

2747

        /// assert_eq!(borrow1, true);

2748

        /// let (diff1, borrow2) = a1.borrowing_sub(b1, borrow1);

2749

        /// assert_eq!(borrow2, false);

2750

///

2751

        #[doc = concat!("assert_eq!((diff1, diff0), (3, ", stringify!($SelfT), "::MAX));")]

2752

        /// ```

2753

        #[stable(feature = "unsigned_bigint_helpers", since = "CURRENT_RUSTC_VERSION")]

2754

        #[rustc_const_unstable(feature = "bigint_helper_methods", issue = "85532")]

2755

        #[must_use = "this returns the result of the operation, \

2756

                      without modifying the original"]

2757

        #[inline]

2758

        #[cfg(not(feature = "ferrocene_certified"))]

2759

        pub const fn borrowing_sub(self, rhs: Self, borrow: bool) -> (Self, bool) {

2760

            // note: longer-term this should be done via an intrinsic, but this has been shown

2761

            //   to generate optimal code for now, and LLVM doesn't have an equivalent intrinsic

2762

            let (a, c1) = self.overflowing_sub(rhs);

2763

            let (b, c2) = a.overflowing_sub(borrow as $SelfT);

2764

            // SAFETY: Only one of `c1` and `c2` can be set.

2765

            // For c1 to be set we need to have underflowed, but if we did then

2766

            // `a` is nonzero, which means that `c2` cannot possibly

2767

            // underflow because it's subtracting at most `1` (since it came from `bool`)

2768

            (b, unsafe { intrinsics::disjoint_bitor(c1, c2) })

2769

2770

2771

        /// Calculates `self` - `rhs` with a signed `rhs`

2772

///

2773

        /// Returns a tuple of the subtraction along with a boolean indicating

2774

        /// whether an arithmetic overflow would occur. If an overflow would

2775

        /// have occurred then the wrapped value is returned.

2776

///

2777

        /// # Examples

2778

///

2779

        /// ```

2780

        #[doc = concat!("assert_eq!(1", stringify!($SelfT), ".overflowing_sub_signed(2), (", stringify!($SelfT), "::MAX, true));")]

2781

        #[doc = concat!("assert_eq!(1", stringify!($SelfT), ".overflowing_sub_signed(-2), (3, false));")]

2782

        #[doc = concat!("assert_eq!((", stringify!($SelfT), "::MAX - 2).overflowing_sub_signed(-4), (1, true));")]

2783

        /// ```

2784

        #[stable(feature = "mixed_integer_ops_unsigned_sub", since = "1.90.0")]

2785

        #[rustc_const_stable(feature = "mixed_integer_ops_unsigned_sub", since = "1.90.0")]

2786

        #[must_use = "this returns the result of the operation, \

2787

                      without modifying the original"]

2788

        #[inline]

2789

        #[cfg(not(feature = "ferrocene_certified"))]

2790

        pub const fn overflowing_sub_signed(self, rhs: $SignedT) -> (Self, bool) {

2791

            let (res, overflow) = self.overflowing_sub(rhs as Self);

2792

2793

            (res, overflow ^ (rhs < 0))

2794

2795

2796

        /// Computes the absolute difference between `self` and `other`.

2797

///

2798

        /// # Examples

2799

///

2800

        /// ```

2801

        #[doc = concat!("assert_eq!(100", stringify!($SelfT), ".abs_diff(80), 20", stringify!($SelfT), ");")]

2802

        #[doc = concat!("assert_eq!(100", stringify!($SelfT), ".abs_diff(110), 10", stringify!($SelfT), ");")]

2803

        /// ```

2804

        #[stable(feature = "int_abs_diff", since = "1.60.0")]

2805

        #[rustc_const_stable(feature = "int_abs_diff", since = "1.60.0")]

2806

        #[must_use = "this returns the result of the operation, \

2807

                      without modifying the original"]

2808

        #[inline]

2809

        #[cfg(not(feature = "ferrocene_certified"))]

2810

        pub const fn abs_diff(self, other: Self) -> Self {

2811

            if size_of::<Self>() == 1 {

2812

                // Trick LLVM into generating the psadbw instruction when SSE2

2813

                // is available and this function is autovectorized for u8's.

2814

                (self as i32).wrapping_sub(other as i32).unsigned_abs() as Self

2815

            } else {

2816

                if self < other {

2817

                    other - self

2818

                } else {

2819

                    self - other

2820

2821

2822

2823

2824

        /// Calculates the multiplication of `self` and `rhs`.

2825

///

2826

        /// Returns a tuple of the multiplication along with a boolean

2827

        /// indicating whether an arithmetic overflow would occur. If an

2828

        /// overflow would have occurred then the wrapped value is returned.

2829

///

2830

        /// If you want the *value* of the overflow, rather than just *whether*

2831

        /// an overflow occurred, see [`Self::carrying_mul`].

2832

///

2833

        /// # Examples

2834

///

2835

        /// Please note that this example is shared among integer types, which is why `u32` is used.

2836

///

2837

        /// ```

2838

        /// assert_eq!(5u32.overflowing_mul(2), (10, false));

2839

        /// assert_eq!(1_000_000_000u32.overflowing_mul(10), (1410065408, true));

2840

        /// ```

2841

        #[stable(feature = "wrapping", since = "1.7.0")]

2842

        #[rustc_const_stable(feature = "const_wrapping_math", since = "1.32.0")]

2843

        #[must_use = "this returns the result of the operation, \

2844

                          without modifying the original"]

2845

        #[inline(always)]

2846

        #[cfg(not(feature = "ferrocene_certified"))]

2847

        pub const fn overflowing_mul(self, rhs: Self) -> (Self, bool) {

2848

            let (a, b) = intrinsics::mul_with_overflow(self as $ActualT, rhs as $ActualT);

2849

            (a as Self, b)

2850

2851

2852

        /// Calculates the complete double-width product `self * rhs`.

2853

///

2854

        /// This returns the low-order (wrapping) bits and the high-order (overflow) bits

2855

        /// of the result as two separate values, in that order. As such,

2856

        /// `a.widening_mul(b).0` produces the same result as `a.wrapping_mul(b)`.

2857

///

2858

        /// If you also need to add a value and carry to the wide result, then you want

2859

        /// [`Self::carrying_mul_add`] instead.

2860

///

2861

        /// If you also need to add a carry to the wide result, then you want

2862

        /// [`Self::carrying_mul`] instead.

2863

///

2864

        /// If you just want to know *whether* the multiplication overflowed, then you

2865

        /// want [`Self::overflowing_mul`] instead.

2866

///

2867

        /// # Examples

2868

///

2869

        /// ```

2870

        /// #![feature(bigint_helper_methods)]

2871

        #[doc = concat!("assert_eq!(5_", stringify!($SelfT), ".widening_mul(7), (35, 0));")]

2872

        #[doc = concat!("assert_eq!(", stringify!($SelfT), "::MAX.widening_mul(", stringify!($SelfT), "::MAX), (1, ", stringify!($SelfT), "::MAX - 1));")]

2873

        /// ```

2874

///

2875

        /// Compared to other `*_mul` methods:

2876

        /// ```

2877

        /// #![feature(bigint_helper_methods)]

2878

        #[doc = concat!("assert_eq!(", stringify!($SelfT), "::widening_mul(1 << ", stringify!($BITS_MINUS_ONE), ", 6), (0, 3));")]

2879

        #[doc = concat!("assert_eq!(", stringify!($SelfT), "::overflowing_mul(1 << ", stringify!($BITS_MINUS_ONE), ", 6), (0, true));")]

2880

        #[doc = concat!("assert_eq!(", stringify!($SelfT), "::wrapping_mul(1 << ", stringify!($BITS_MINUS_ONE), ", 6), 0);")]

2881

        #[doc = concat!("assert_eq!(", stringify!($SelfT), "::checked_mul(1 << ", stringify!($BITS_MINUS_ONE), ", 6), None);")]

2882

        /// ```

2883

///

2884

        /// Please note that this example is shared among integer types, which is why `u32` is used.

2885

///

2886

        /// ```

2887

        /// #![feature(bigint_helper_methods)]

2888

        /// assert_eq!(5u32.widening_mul(2), (10, 0));

2889

        /// assert_eq!(1_000_000_000u32.widening_mul(10), (1410065408, 2));

2890

        /// ```

2891

        #[unstable(feature = "bigint_helper_methods", issue = "85532")]

2892

        #[rustc_const_unstable(feature = "bigint_helper_methods", issue = "85532")]

2893

        #[must_use = "this returns the result of the operation, \

2894

                      without modifying the original"]

2895

        #[inline]

2896

        #[cfg(not(feature = "ferrocene_certified"))]

2897

        pub const fn widening_mul(self, rhs: Self) -> (Self, Self) {

2898

            Self::carrying_mul_add(self, rhs, 0, 0)

2899

2900

2901

        /// Calculates the "full multiplication" `self * rhs + carry`

2902

        /// without the possibility to overflow.

2903

///

2904

        /// This returns the low-order (wrapping) bits and the high-order (overflow) bits

2905

        /// of the result as two separate values, in that order.

2906

///

2907

        /// Performs "long multiplication" which takes in an extra amount to add, and may return an

2908

        /// additional amount of overflow. This allows for chaining together multiple

2909

        /// multiplications to create "big integers" which represent larger values.

2910

///

2911

        /// If you also need to add a value, then use [`Self::carrying_mul_add`].

2912

///

2913

        /// # Examples

2914

///

2915

        /// Please note that this example is shared among integer types, which is why `u32` is used.

2916

///

2917

        /// ```

2918

        /// assert_eq!(5u32.carrying_mul(2, 0), (10, 0));

2919

        /// assert_eq!(5u32.carrying_mul(2, 10), (20, 0));

2920

        /// assert_eq!(1_000_000_000u32.carrying_mul(10, 0), (1410065408, 2));

2921

        /// assert_eq!(1_000_000_000u32.carrying_mul(10, 10), (1410065418, 2));

2922

        #[doc = concat!("assert_eq!(",

2923

            stringify!($SelfT), "::MAX.carrying_mul(", stringify!($SelfT), "::MAX, ", stringify!($SelfT), "::MAX), ",

2924

            "(0, ", stringify!($SelfT), "::MAX));"

2925

)]

2926

        /// ```

2927

///

2928

        /// This is the core operation needed for scalar multiplication when

2929

        /// implementing it for wider-than-native types.

2930

///

2931

        /// ```

2932

        /// #![feature(bigint_helper_methods)]

2933

        /// fn scalar_mul_eq(little_endian_digits: &mut Vec<u16>, multiplicand: u16) {

2934

        ///     let mut carry = 0;

2935

        ///     for d in little_endian_digits.iter_mut() {

2936

        ///         (*d, carry) = d.carrying_mul(multiplicand, carry);

2937

        ///     }

2938

        ///     if carry != 0 {

2939

        ///         little_endian_digits.push(carry);

2940

        ///     }

2941

        /// }

2942

///

2943

        /// let mut v = vec![10, 20];

2944

        /// scalar_mul_eq(&mut v, 3);

2945

        /// assert_eq!(v, [30, 60]);

2946

///

2947

        /// assert_eq!(0x87654321_u64 * 0xFEED, 0x86D3D159E38D);

2948

        /// let mut v = vec![0x4321, 0x8765];

2949

        /// scalar_mul_eq(&mut v, 0xFEED);

2950

        /// assert_eq!(v, [0xE38D, 0xD159, 0x86D3]);

2951

        /// ```

2952

///

2953

        /// If `carry` is zero, this is similar to [`overflowing_mul`](Self::overflowing_mul),

2954

        /// except that it gives the value of the overflow instead of just whether one happened:

2955

///

2956

        /// ```

2957

        /// #![feature(bigint_helper_methods)]

2958

        /// let r = u8::carrying_mul(7, 13, 0);

2959

        /// assert_eq!((r.0, r.1 != 0), u8::overflowing_mul(7, 13));

2960

        /// let r = u8::carrying_mul(13, 42, 0);

2961

        /// assert_eq!((r.0, r.1 != 0), u8::overflowing_mul(13, 42));

2962

        /// ```

2963

///

2964

        /// The value of the first field in the returned tuple matches what you'd get

2965

        /// by combining the [`wrapping_mul`](Self::wrapping_mul) and

2966

        /// [`wrapping_add`](Self::wrapping_add) methods:

2967

///

2968

        /// ```

2969

        /// #![feature(bigint_helper_methods)]

2970

        /// assert_eq!(

2971

        ///     789_u16.carrying_mul(456, 123).0,

2972

        ///     789_u16.wrapping_mul(456).wrapping_add(123),

2973

        /// );

2974

        /// ```

2975

        #[stable(feature = "unsigned_bigint_helpers", since = "CURRENT_RUSTC_VERSION")]

2976

        #[rustc_const_unstable(feature = "bigint_helper_methods", issue = "85532")]

2977

        #[must_use = "this returns the result of the operation, \

2978

                      without modifying the original"]

2979

        #[inline]

2980

        #[cfg(not(feature = "ferrocene_certified"))]

2981

        pub const fn carrying_mul(self, rhs: Self, carry: Self) -> (Self, Self) {

2982

            Self::carrying_mul_add(self, rhs, carry, 0)

2983

2984

2985

        /// Calculates the "full multiplication" `self * rhs + carry1 + carry2`.

2986

///

2987

        /// This returns the low-order (wrapping) bits and the high-order (overflow) bits

2988

        /// of the result as two separate values, in that order.

2989

///

2990

        /// This cannot overflow, as the double-width result has exactly enough

2991

        /// space for the largest possible result. This is equivalent to how, in

2992

        /// decimal, 9 × 9 + 9 + 9 = 81 + 18 = 99 = 9×10⁰ + 9×10¹ = 10² - 1.

2993

///

2994

        /// Performs "long multiplication" which takes in an extra amount to add, and may return an

2995

        /// additional amount of overflow. This allows for chaining together multiple

2996

        /// multiplications to create "big integers" which represent larger values.

2997

///

2998

        /// If you don't need the `add` part, then you can use [`Self::carrying_mul`] instead.

2999

///

3000

        /// # Examples

3001

///

3002

        /// Please note that this example is shared between integer types,

3003

        /// which explains why `u32` is used here.

3004

///

3005

        /// ```

3006

        /// assert_eq!(5u32.carrying_mul_add(2, 0, 0), (10, 0));

3007

        /// assert_eq!(5u32.carrying_mul_add(2, 10, 10), (30, 0));

3008

        /// assert_eq!(1_000_000_000u32.carrying_mul_add(10, 0, 0), (1410065408, 2));

3009

        /// assert_eq!(1_000_000_000u32.carrying_mul_add(10, 10, 10), (1410065428, 2));

3010

        #[doc = concat!("assert_eq!(",

3011

            stringify!($SelfT), "::MAX.carrying_mul_add(", stringify!($SelfT), "::MAX, ", stringify!($SelfT), "::MAX, ", stringify!($SelfT), "::MAX), ",

3012

            "(", stringify!($SelfT), "::MAX, ", stringify!($SelfT), "::MAX));"

3013

)]

3014

        /// ```

3015

///

3016

        /// This is the core per-digit operation for "grade school" O(n²) multiplication.

3017

///

3018

        /// Please note that this example is shared between integer types,

3019

        /// using `u8` for simplicity of the demonstration.

3020

///

3021

        /// ```

3022

        /// fn quadratic_mul<const N: usize>(a: [u8; N], b: [u8; N]) -> [u8; N] {

3023

        ///     let mut out = [0; N];

3024

        ///     for j in 0..N {

3025

        ///         let mut carry = 0;

3026

        ///         for i in 0..(N - j) {

3027

        ///             (out[j + i], carry) = u8::carrying_mul_add(a[i], b[j], out[j + i], carry);

3028

        ///         }

3029

        ///     }

3030

        ///     out

3031

        /// }

3032

///

3033

        /// // -1 * -1 == 1

3034

        /// assert_eq!(quadratic_mul([0xFF; 3], [0xFF; 3]), [1, 0, 0]);

3035

///

3036

        /// assert_eq!(u32::wrapping_mul(0x9e3779b9, 0x7f4a7c15), 0xcffc982d);

3037

        /// assert_eq!(

3038

        ///     quadratic_mul(u32::to_le_bytes(0x9e3779b9), u32::to_le_bytes(0x7f4a7c15)),

3039

        ///     u32::to_le_bytes(0xcffc982d)

3040

        /// );

3041

        /// ```

3042

        #[stable(feature = "unsigned_bigint_helpers", since = "CURRENT_RUSTC_VERSION")]

3043

        #[rustc_const_unstable(feature = "bigint_helper_methods", issue = "85532")]

3044

        #[must_use = "this returns the result of the operation, \

3045

                      without modifying the original"]

3046

        #[inline]

3047

        #[cfg(not(feature = "ferrocene_certified"))]

3048

        pub const fn carrying_mul_add(self, rhs: Self, carry: Self, add: Self) -> (Self, Self) {

3049

            intrinsics::carrying_mul_add(self, rhs, carry, add)

3050

3051

3052

        /// Calculates the divisor when `self` is divided by `rhs`.

3053

///

3054

        /// Returns a tuple of the divisor along with a boolean indicating

3055

        /// whether an arithmetic overflow would occur. Note that for unsigned

3056

        /// integers overflow never occurs, so the second value is always

3057

        /// `false`.

3058

///

3059

        /// # Panics

3060

///

3061

        /// This function will panic if `rhs` is zero.

3062

///

3063

        /// # Examples

3064

///

3065

        /// ```

3066

        #[doc = concat!("assert_eq!(5", stringify!($SelfT), ".overflowing_div(2), (2, false));")]

3067

        /// ```

3068

        #[inline(always)]

3069

        #[stable(feature = "wrapping", since = "1.7.0")]

3070

        #[rustc_const_stable(feature = "const_overflowing_int_methods", since = "1.52.0")]

3071

        #[must_use = "this returns the result of the operation, \

3072

                      without modifying the original"]

3073

        #[track_caller]

3074

        #[cfg(not(feature = "ferrocene_certified"))]

3075

        pub const fn overflowing_div(self, rhs: Self) -> (Self, bool) {

3076

            (self / rhs, false)

3077

3078

3079

        /// Calculates the quotient of Euclidean division `self.div_euclid(rhs)`.

3080

///

3081

        /// Returns a tuple of the divisor along with a boolean indicating

3082

        /// whether an arithmetic overflow would occur. Note that for unsigned

3083

        /// integers overflow never occurs, so the second value is always

3084

        /// `false`.

3085

        /// Since, for the positive integers, all common

3086

        /// definitions of division are equal, this

3087

        /// is exactly equal to `self.overflowing_div(rhs)`.

3088

///

3089

        /// # Panics

3090

///

3091

        /// This function will panic if `rhs` is zero.

3092

///

3093

        /// # Examples

3094

///

3095

        /// ```

3096

        #[doc = concat!("assert_eq!(5", stringify!($SelfT), ".overflowing_div_euclid(2), (2, false));")]

3097

        /// ```

3098

        #[inline(always)]

3099

        #[stable(feature = "euclidean_division", since = "1.38.0")]

3100

        #[rustc_const_stable(feature = "const_euclidean_int_methods", since = "1.52.0")]

3101

        #[must_use = "this returns the result of the operation, \

3102

                      without modifying the original"]

3103

        #[track_caller]

3104

        #[cfg(not(feature = "ferrocene_certified"))]

3105

        pub const fn overflowing_div_euclid(self, rhs: Self) -> (Self, bool) {

3106

            (self / rhs, false)

3107

3108

3109

        /// Calculates the remainder when `self` is divided by `rhs`.

3110

///

3111

        /// Returns a tuple of the remainder after dividing along with a boolean

3112

        /// indicating whether an arithmetic overflow would occur. Note that for

3113

        /// unsigned integers overflow never occurs, so the second value is

3114

        /// always `false`.

3115

///

3116

        /// # Panics

3117

///

3118

        /// This function will panic if `rhs` is zero.

3119

///

3120

        /// # Examples

3121

///

3122

        /// ```

3123

        #[doc = concat!("assert_eq!(5", stringify!($SelfT), ".overflowing_rem(2), (1, false));")]

3124

        /// ```

3125

        #[inline(always)]

3126

        #[stable(feature = "wrapping", since = "1.7.0")]

3127

        #[rustc_const_stable(feature = "const_overflowing_int_methods", since = "1.52.0")]

3128

        #[must_use = "this returns the result of the operation, \

3129

                      without modifying the original"]

3130

        #[track_caller]

3131

        #[cfg(not(feature = "ferrocene_certified"))]

3132

        pub const fn overflowing_rem(self, rhs: Self) -> (Self, bool) {

3133

            (self % rhs, false)

3134

3135

3136

        /// Calculates the remainder `self.rem_euclid(rhs)` as if by Euclidean division.

3137

///

3138

        /// Returns a tuple of the modulo after dividing along with a boolean

3139

        /// indicating whether an arithmetic overflow would occur. Note that for

3140

        /// unsigned integers overflow never occurs, so the second value is

3141

        /// always `false`.

3142

        /// Since, for the positive integers, all common

3143

        /// definitions of division are equal, this operation

3144

        /// is exactly equal to `self.overflowing_rem(rhs)`.

3145

///

3146

        /// # Panics

3147

///

3148

        /// This function will panic if `rhs` is zero.

3149

///

3150

        /// # Examples

3151

///

3152

        /// ```

3153

        #[doc = concat!("assert_eq!(5", stringify!($SelfT), ".overflowing_rem_euclid(2), (1, false));")]

3154

        /// ```

3155

        #[inline(always)]

3156

        #[stable(feature = "euclidean_division", since = "1.38.0")]

3157

        #[rustc_const_stable(feature = "const_euclidean_int_methods", since = "1.52.0")]

3158

        #[must_use = "this returns the result of the operation, \

3159

                      without modifying the original"]

3160

        #[track_caller]

3161

        #[cfg(not(feature = "ferrocene_certified"))]

3162

        pub const fn overflowing_rem_euclid(self, rhs: Self) -> (Self, bool) {

3163

            (self % rhs, false)

3164

3165

3166

        /// Negates self in an overflowing fashion.

3167

///

3168

        /// Returns `!self + 1` using wrapping operations to return the value

3169

        /// that represents the negation of this unsigned value. Note that for

3170

        /// positive unsigned values overflow always occurs, but negating 0 does

3171

        /// not overflow.

3172

///

3173

        /// # Examples

3174

///

3175

        /// ```

3176

        #[doc = concat!("assert_eq!(0", stringify!($SelfT), ".overflowing_neg(), (0, false));")]

3177

        #[doc = concat!("assert_eq!(2", stringify!($SelfT), ".overflowing_neg(), (-2i32 as ", stringify!($SelfT), ", true));")]

3178

        /// ```

3179

        #[inline(always)]

3180

        #[stable(feature = "wrapping", since = "1.7.0")]

3181

        #[rustc_const_stable(feature = "const_wrapping_math", since = "1.32.0")]

3182

        #[must_use = "this returns the result of the operation, \

3183

                      without modifying the original"]

3184

        #[cfg(not(feature = "ferrocene_certified"))]

3185

        pub const fn overflowing_neg(self) -> (Self, bool) {

3186

            ((!self).wrapping_add(1), self != 0)

3187

3188

3189

        /// Shifts self left by `rhs` bits.

3190

///

3191

        /// Returns a tuple of the shifted version of self along with a boolean

3192

        /// indicating whether the shift value was larger than or equal to the

3193

        /// number of bits. If the shift value is too large, then value is

3194

        /// masked (N-1) where N is the number of bits, and this value is then

3195

        /// used to perform the shift.

3196

///

3197

        /// # Examples

3198

///

3199

        /// ```

3200

        #[doc = concat!("assert_eq!(0x1", stringify!($SelfT), ".overflowing_shl(4), (0x10, false));")]

3201

        #[doc = concat!("assert_eq!(0x1", stringify!($SelfT), ".overflowing_shl(132), (0x10, true));")]

3202

        #[doc = concat!("assert_eq!(0x10", stringify!($SelfT), ".overflowing_shl(", stringify!($BITS_MINUS_ONE), "), (0, false));")]

3203

        /// ```

3204

        #[stable(feature = "wrapping", since = "1.7.0")]

3205

        #[rustc_const_stable(feature = "const_wrapping_math", since = "1.32.0")]

3206

        #[must_use = "this returns the result of the operation, \

3207

                      without modifying the original"]

3208

        #[inline(always)]

3209

        #[cfg(not(feature = "ferrocene_certified"))]

3210

        pub const fn overflowing_shl(self, rhs: u32) -> (Self, bool) {

3211

            (self.wrapping_shl(rhs), rhs >= Self::BITS)

3212

3213

3214

        /// Shifts self right by `rhs` bits.

3215

///

3216

        /// Returns a tuple of the shifted version of self along with a boolean

3217

        /// indicating whether the shift value was larger than or equal to the

3218

        /// number of bits. If the shift value is too large, then value is

3219

        /// masked (N-1) where N is the number of bits, and this value is then

3220

        /// used to perform the shift.

3221

///

3222

        /// # Examples

3223

///

3224

        /// ```

3225

        #[doc = concat!("assert_eq!(0x10", stringify!($SelfT), ".overflowing_shr(4), (0x1, false));")]

3226

        #[doc = concat!("assert_eq!(0x10", stringify!($SelfT), ".overflowing_shr(132), (0x1, true));")]

3227

        /// ```

3228

        #[stable(feature = "wrapping", since = "1.7.0")]

3229

        #[rustc_const_stable(feature = "const_wrapping_math", since = "1.32.0")]

3230

        #[must_use = "this returns the result of the operation, \

3231

                      without modifying the original"]

3232

        #[inline(always)]

3233

        #[cfg(not(feature = "ferrocene_certified"))]

3234

        pub const fn overflowing_shr(self, rhs: u32) -> (Self, bool) {

3235

            (self.wrapping_shr(rhs), rhs >= Self::BITS)

3236

3237

3238

        /// Raises self to the power of `exp`, using exponentiation by squaring.

3239

///

3240

        /// Returns a tuple of the exponentiation along with a bool indicating

3241

        /// whether an overflow happened.

3242

///

3243

        /// # Examples

3244

///

3245

        /// ```

3246

        #[doc = concat!("assert_eq!(3", stringify!($SelfT), ".overflowing_pow(5), (243, false));")]

3247

        /// assert_eq!(3u8.overflowing_pow(6), (217, true));

3248

        /// ```

3249

        #[stable(feature = "no_panic_pow", since = "1.34.0")]

3250

        #[rustc_const_stable(feature = "const_int_pow", since = "1.50.0")]

3251

        #[must_use = "this returns the result of the operation, \

3252

                      without modifying the original"]

3253

        #[inline]

3254

        #[cfg(not(feature = "ferrocene_certified"))]

3255

        pub const fn overflowing_pow(self, mut exp: u32) -> (Self, bool) {

3256

            if exp == 0{

3257

                return (1,false);

3258

3259

            let mut base = self;

3260

            let mut acc: Self = 1;

3261

            let mut overflown = false;

3262

            // Scratch space for storing results of overflowing_mul.

3263

            let mut r;

3264

3265

            loop {

3266

                if (exp & 1) == 1 {

3267

                    r = acc.overflowing_mul(base);

3268

                    // since exp!=0, finally the exp must be 1.

3269

                    if exp == 1 {

3270

                        r.1 |= overflown;

3271

                        return r;

3272

3273

                    acc = r.0;

3274

                    overflown |= r.1;

3275

3276

                exp /= 2;

3277

                r = base.overflowing_mul(base);

3278

                base = r.0;

3279

                overflown |= r.1;

3280

3281

3282

3283

        /// Raises self to the power of `exp`, using exponentiation by squaring.

3284

///

3285

        /// # Examples

3286

///

3287

        /// ```

3288

        #[doc = concat!("assert_eq!(2", stringify!($SelfT), ".pow(5), 32);")]

3289

        /// ```

3290

        #[stable(feature = "rust1", since = "1.0.0")]

3291

        #[rustc_const_stable(feature = "const_int_pow", since = "1.50.0")]

3292

        #[must_use = "this returns the result of the operation, \

3293

                      without modifying the original"]

3294

        #[inline]

3295

        #[rustc_inherit_overflow_checks]

3296

        #[cfg(not(feature = "ferrocene_certified"))]

3297

        pub const fn pow(self, mut exp: u32) -> Self {

3298

            if exp == 0 {

3299

                return 1;

3300

3301

            let mut base = self;

3302

            let mut acc = 1;

3303

3304

            if intrinsics::is_val_statically_known(exp) {

3305

                while exp > 1 {

3306

                    if (exp & 1) == 1 {

3307

                        acc = acc * base;

3308

3309

                    exp /= 2;

3310

                    base = base * base;

3311

3312

3313

                // since exp!=0, finally the exp must be 1.

3314

                // Deal with the final bit of the exponent separately, since

3315

                // squaring the base afterwards is not necessary and may cause a

3316

                // needless overflow.

3317

                acc * base

3318

            } else {

3319

                // This is faster than the above when the exponent is not known

3320

                // at compile time. We can't use the same code for the constant

3321

                // exponent case because LLVM is currently unable to unroll

3322

                // this loop.

3323

                loop {

3324

                    if (exp & 1) == 1 {

3325

                        acc = acc * base;

3326

                        // since exp!=0, finally the exp must be 1.

3327

                        if exp == 1 {

3328

                            return acc;

3329

3330

3331

                    exp /= 2;

3332

                    base = base * base;

3333

3334

3335

3336

3337

        /// Returns the square root of the number, rounded down.

3338

///

3339

        /// # Examples

3340

///

3341

        /// ```

3342

        #[doc = concat!("assert_eq!(10", stringify!($SelfT), ".isqrt(), 3);")]

3343

        /// ```

3344

        #[stable(feature = "isqrt", since = "1.84.0")]

3345

        #[rustc_const_stable(feature = "isqrt", since = "1.84.0")]

3346

        #[must_use = "this returns the result of the operation, \

3347

                      without modifying the original"]

3348

        #[inline]

3349

        #[cfg(not(feature = "ferrocene_certified"))]

3350

        pub const fn isqrt(self) -> Self {

3351

            let result = crate::num::int_sqrt::$ActualT(self as $ActualT) as $SelfT;

3352

3353

            // Inform the optimizer what the range of outputs is. If testing

3354

            // `core` crashes with no panic message and a `num::int_sqrt::u*`

3355

            // test failed, it's because your edits caused these assertions or

3356

            // the assertions in `fn isqrt` of `nonzero.rs` to become false.

3357

//

3358

            // SAFETY: Integer square root is a monotonically nondecreasing

3359

            // function, which means that increasing the input will never

3360

            // cause the output to decrease. Thus, since the input for unsigned

3361

            // integers is bounded by `[0, <$ActualT>::MAX]`, sqrt(n) will be

3362

            // bounded by `[sqrt(0), sqrt(<$ActualT>::MAX)]`.

3363

            unsafe {

3364

                const MAX_RESULT: $SelfT = crate::num::int_sqrt::$ActualT(<$ActualT>::MAX) as $SelfT;

3365

                crate::hint::assert_unchecked(result <= MAX_RESULT);

3366

3367

3368

            result

3369

3370

3371

        /// Performs Euclidean division.

3372

///

3373

        /// Since, for the positive integers, all common

3374

        /// definitions of division are equal, this

3375

        /// is exactly equal to `self / rhs`.

3376

///

3377

        /// # Panics

3378

///

3379

        /// This function will panic if `rhs` is zero.

3380

///

3381

        /// # Examples

3382

///

3383

        /// ```

3384

        #[doc = concat!("assert_eq!(7", stringify!($SelfT), ".div_euclid(4), 1); // or any other integer type")]

3385

        /// ```

3386

        #[stable(feature = "euclidean_division", since = "1.38.0")]

3387

        #[rustc_const_stable(feature = "const_euclidean_int_methods", since = "1.52.0")]

3388

        #[must_use = "this returns the result of the operation, \

3389

                      without modifying the original"]

3390

        #[inline(always)]

3391

        #[track_caller]

3392

        #[cfg(not(feature = "ferrocene_certified"))]

3393

        pub const fn div_euclid(self, rhs: Self) -> Self {

3394

            self / rhs

3395

3396

3397

3398

        /// Calculates the least remainder of `self (mod rhs)`.

3399

///

3400

        /// Since, for the positive integers, all common

3401

        /// definitions of division are equal, this

3402

        /// is exactly equal to `self % rhs`.

3403

///

3404

        /// # Panics

3405

///

3406

        /// This function will panic if `rhs` is zero.

3407

///

3408

        /// # Examples

3409

///

3410

        /// ```

3411

        #[doc = concat!("assert_eq!(7", stringify!($SelfT), ".rem_euclid(4), 3); // or any other integer type")]

3412

        /// ```

3413

        #[doc(alias = "modulo", alias = "mod")]

3414

        #[stable(feature = "euclidean_division", since = "1.38.0")]

3415

        #[rustc_const_stable(feature = "const_euclidean_int_methods", since = "1.52.0")]

3416

        #[must_use = "this returns the result of the operation, \

3417

                      without modifying the original"]

3418

        #[inline(always)]

3419

        #[track_caller]

3420

        #[cfg(not(feature = "ferrocene_certified"))]

3421

        pub const fn rem_euclid(self, rhs: Self) -> Self {

3422

            self % rhs

3423

3424

3425

        /// Calculates the quotient of `self` and `rhs`, rounding the result towards negative infinity.

3426

///

3427

        /// This is the same as performing `self / rhs` for all unsigned integers.

3428

///

3429

        /// # Panics

3430

///

3431

        /// This function will panic if `rhs` is zero.

3432

///

3433

        /// # Examples

3434

///

3435

        /// ```

3436

        /// #![feature(int_roundings)]

3437

        #[doc = concat!("assert_eq!(7_", stringify!($SelfT), ".div_floor(4), 1);")]

3438

        /// ```

3439

        #[unstable(feature = "int_roundings", issue = "88581")]

3440

        #[must_use = "this returns the result of the operation, \

3441

                      without modifying the original"]

3442

        #[inline(always)]

3443

        #[track_caller]

3444

        #[cfg(not(feature = "ferrocene_certified"))]

3445

        pub const fn div_floor(self, rhs: Self) -> Self {

3446

            self / rhs

3447

3448

3449

        /// Calculates the quotient of `self` and `rhs`, rounding the result towards positive infinity.

3450

///

3451

        /// # Panics

3452

///

3453

        /// This function will panic if `rhs` is zero.

3454

///

3455

        /// # Examples

3456

///

3457

        /// ```

3458

        #[doc = concat!("assert_eq!(7_", stringify!($SelfT), ".div_ceil(4), 2);")]

3459

        /// ```

3460

        #[stable(feature = "int_roundings1", since = "1.73.0")]

3461

        #[rustc_const_stable(feature = "int_roundings1", since = "1.73.0")]

3462

        #[must_use = "this returns the result of the operation, \

3463

                      without modifying the original"]

3464

        #[inline]

3465

        #[track_caller]

3466

        #[cfg(not(feature = "ferrocene_certified"))]

3467

        pub const fn div_ceil(self, rhs: Self) -> Self {

3468

            let d = self / rhs;

3469

            let r = self % rhs;

3470

            if r > 0 {

3471

                d + 1

3472

            } else {

3473

3474

3475

3476

3477

        /// Calculates the smallest value greater than or equal to `self` that

3478

        /// is a multiple of `rhs`.

3479

///

3480

        /// # Panics

3481

///

3482

        /// This function will panic if `rhs` is zero.

3483

///

3484

        /// ## Overflow behavior

3485

///

3486

        /// On overflow, this function will panic if overflow checks are enabled (default in debug

3487

        /// mode) and wrap if overflow checks are disabled (default in release mode).

3488

///

3489

        /// # Examples

3490

///

3491

        /// ```

3492

        #[doc = concat!("assert_eq!(16_", stringify!($SelfT), ".next_multiple_of(8), 16);")]

3493

        #[doc = concat!("assert_eq!(23_", stringify!($SelfT), ".next_multiple_of(8), 24);")]

3494

        /// ```

3495

        #[stable(feature = "int_roundings1", since = "1.73.0")]

3496

        #[rustc_const_stable(feature = "int_roundings1", since = "1.73.0")]

3497

        #[must_use = "this returns the result of the operation, \

3498

                      without modifying the original"]

3499

        #[inline]

3500

        #[rustc_inherit_overflow_checks]

3501

        #[cfg(not(feature = "ferrocene_certified"))]

3502

        pub const fn next_multiple_of(self, rhs: Self) -> Self {

3503

            match self % rhs {

3504

                0 => self,

3505

                r => self + (rhs - r)

3506

3507

3508

3509

        /// Calculates the smallest value greater than or equal to `self` that

3510

        /// is a multiple of `rhs`. Returns `None` if `rhs` is zero or the

3511

        /// operation would result in overflow.

3512

///

3513

        /// # Examples

3514

///

3515

        /// ```

3516

        #[doc = concat!("assert_eq!(16_", stringify!($SelfT), ".checked_next_multiple_of(8), Some(16));")]

3517

        #[doc = concat!("assert_eq!(23_", stringify!($SelfT), ".checked_next_multiple_of(8), Some(24));")]

3518

        #[doc = concat!("assert_eq!(1_", stringify!($SelfT), ".checked_next_multiple_of(0), None);")]

3519

        #[doc = concat!("assert_eq!(", stringify!($SelfT), "::MAX.checked_next_multiple_of(2), None);")]

3520

        /// ```

3521

        #[stable(feature = "int_roundings1", since = "1.73.0")]

3522

        #[rustc_const_stable(feature = "int_roundings1", since = "1.73.0")]

3523

        #[must_use = "this returns the result of the operation, \

3524

                      without modifying the original"]

3525

        #[inline]

3526

        #[cfg(not(feature = "ferrocene_certified"))]

3527

        pub const fn checked_next_multiple_of(self, rhs: Self) -> Option<Self> {

3528

            match try_opt!(self.checked_rem(rhs)) {

3529

                0 => Some(self),

3530

                // rhs - r cannot overflow because r is smaller than rhs

3531

                r => self.checked_add(rhs - r)

3532

3533

3534

3535

        /// Returns `true` if `self` is an integer multiple of `rhs`, and false otherwise.

3536

///

3537

        /// This function is equivalent to `self % rhs == 0`, except that it will not panic

3538

        /// for `rhs == 0`. Instead, `0.is_multiple_of(0) == true`, and for any non-zero `n`,

3539

        /// `n.is_multiple_of(0) == false`.

3540

///

3541

        /// # Examples

3542

///

3543

        /// ```

3544

        #[doc = concat!("assert!(6_", stringify!($SelfT), ".is_multiple_of(2));")]

3545

        #[doc = concat!("assert!(!5_", stringify!($SelfT), ".is_multiple_of(2));")]

3546

///

3547

        #[doc = concat!("assert!(0_", stringify!($SelfT), ".is_multiple_of(0));")]

3548

        #[doc = concat!("assert!(!6_", stringify!($SelfT), ".is_multiple_of(0));")]

3549

        /// ```

3550

        #[stable(feature = "unsigned_is_multiple_of", since = "1.87.0")]

3551

        #[rustc_const_stable(feature = "unsigned_is_multiple_of", since = "1.87.0")]

3552

        #[must_use]

3553

        #[inline]

3554

        #[rustc_inherit_overflow_checks]

3555

        #[cfg(not(feature = "ferrocene_certified"))]

3556

        pub const fn is_multiple_of(self, rhs: Self) -> bool {

3557

            match rhs {

3558

                0 => self == 0,

3559

                _ => self % rhs == 0,

3560

3561

3562

3563

        /// Returns `true` if and only if `self == 2^k` for some unsigned integer `k`.

3564

///

3565

        /// # Examples

3566

///

3567

        /// ```

3568

        #[doc = concat!("assert!(16", stringify!($SelfT), ".is_power_of_two());")]

3569

        #[doc = concat!("assert!(!10", stringify!($SelfT), ".is_power_of_two());")]

3570

        /// ```

3571

        #[must_use]

3572

        #[stable(feature = "rust1", since = "1.0.0")]

3573

        #[rustc_const_stable(feature = "const_is_power_of_two", since = "1.32.0")]

3574

        #[inline(always)]

3575

13108680

        pub const fn is_power_of_two(self) -> bool {

3576

13108680

            self.count_ones() == 1

3577

13108680

3578

3579

        // Returns one less than next power of two.

3580

        // (For 8u8 next power of two is 8u8 and for 6u8 it is 8u8)

3581

//

3582

        // 8u8.one_less_than_next_power_of_two() == 7

3583

        // 6u8.one_less_than_next_power_of_two() == 7

3584

//

3585

        // This method cannot overflow, as in the `next_power_of_two`

3586

        // overflow cases it instead ends up returning the maximum value

3587

        // of the type, and can return 0 for 0.

3588

        #[inline]

3589

        #[cfg(not(feature = "ferrocene_certified"))]

3590

        const fn one_less_than_next_power_of_two(self) -> Self {

3591

            if self <= 1 { return 0; }

3592

3593

            let p = self - 1;

3594

            // SAFETY: Because `p > 0`, it cannot consist entirely of leading zeros.

3595

            // That means the shift is always in-bounds, and some processors

3596

            // (such as intel pre-haswell) have more efficient ctlz

3597

            // intrinsics when the argument is non-zero.

3598

            let z = unsafe { intrinsics::ctlz_nonzero(p) };

3599

            <$SelfT>::MAX >> z

3600

3601

3602

        /// Returns the smallest power of two greater than or equal to `self`.

3603

///

3604

        /// When return value overflows (i.e., `self > (1 << (N-1))` for type

3605

        /// `uN`), it panics in debug mode and the return value is wrapped to 0 in

3606

        /// release mode (the only situation in which this method can return 0).

3607

///

3608

        /// # Examples

3609

///

3610

        /// ```

3611

        #[doc = concat!("assert_eq!(2", stringify!($SelfT), ".next_power_of_two(), 2);")]

3612

        #[doc = concat!("assert_eq!(3", stringify!($SelfT), ".next_power_of_two(), 4);")]

3613

        #[doc = concat!("assert_eq!(0", stringify!($SelfT), ".next_power_of_two(), 1);")]

3614

        /// ```

3615

        #[stable(feature = "rust1", since = "1.0.0")]

3616

        #[rustc_const_stable(feature = "const_int_pow", since = "1.50.0")]

3617

        #[must_use = "this returns the result of the operation, \

3618

                      without modifying the original"]

3619

        #[inline]

3620

        #[rustc_inherit_overflow_checks]

3621

        #[cfg(not(feature = "ferrocene_certified"))]

3622

        pub const fn next_power_of_two(self) -> Self {

3623

            self.one_less_than_next_power_of_two() + 1

3624

3625

3626

        /// Returns the smallest power of two greater than or equal to `self`. If

3627

        /// the next power of two is greater than the type's maximum value,

3628

        /// `None` is returned, otherwise the power of two is wrapped in `Some`.

3629

///

3630

        /// # Examples

3631

///

3632

        /// ```

3633

        #[doc = concat!("assert_eq!(2", stringify!($SelfT), ".checked_next_power_of_two(), Some(2));")]

3634

        #[doc = concat!("assert_eq!(3", stringify!($SelfT), ".checked_next_power_of_two(), Some(4));")]

3635

        #[doc = concat!("assert_eq!(", stringify!($SelfT), "::MAX.checked_next_power_of_two(), None);")]

3636

        /// ```

3637

        #[inline]

3638

        #[stable(feature = "rust1", since = "1.0.0")]

3639

        #[rustc_const_stable(feature = "const_int_pow", since = "1.50.0")]

3640

        #[must_use = "this returns the result of the operation, \

3641

                      without modifying the original"]

3642

        #[cfg(not(feature = "ferrocene_certified"))]

3643

        pub const fn checked_next_power_of_two(self) -> Option<Self> {

3644

            self.one_less_than_next_power_of_two().checked_add(1)

3645

3646

3647

        /// Returns the smallest power of two greater than or equal to `n`. If

3648

        /// the next power of two is greater than the type's maximum value,

3649

        /// the return value is wrapped to `0`.

3650

///

3651

        /// # Examples

3652

///

3653

        /// ```

3654

        /// #![feature(wrapping_next_power_of_two)]

3655

///

3656

        #[doc = concat!("assert_eq!(2", stringify!($SelfT), ".wrapping_next_power_of_two(), 2);")]

3657

        #[doc = concat!("assert_eq!(3", stringify!($SelfT), ".wrapping_next_power_of_two(), 4);")]

3658

        #[doc = concat!("assert_eq!(", stringify!($SelfT), "::MAX.wrapping_next_power_of_two(), 0);")]

3659

        /// ```

3660

        #[inline]

3661

        #[unstable(feature = "wrapping_next_power_of_two", issue = "32463",

3662

                   reason = "needs decision on wrapping behavior")]

3663

        #[must_use = "this returns the result of the operation, \

3664

                      without modifying the original"]

3665

        #[cfg(not(feature = "ferrocene_certified"))]

3666

        pub const fn wrapping_next_power_of_two(self) -> Self {

3667

            self.one_less_than_next_power_of_two().wrapping_add(1)

3668

3669

3670

        /// Returns the memory representation of this integer as a byte array in

3671

        /// big-endian (network) byte order.

3672

///

3673

        #[doc = $to_xe_bytes_doc]

3674

///

3675

        /// # Examples

3676

///

3677

        /// ```

3678

        #[doc = concat!("let bytes = ", $swap_op, stringify!($SelfT), ".to_be_bytes();")]

3679

        #[doc = concat!("assert_eq!(bytes, ", $be_bytes, ");")]

3680

        /// ```

3681

        #[stable(feature = "int_to_from_bytes", since = "1.32.0")]

3682

        #[rustc_const_stable(feature = "const_int_conversion", since = "1.44.0")]

3683

        #[must_use = "this returns the result of the operation, \

3684

                      without modifying the original"]

3685

        #[inline]

3686

        #[cfg(not(feature = "ferrocene_certified"))]

3687

        pub const fn to_be_bytes(self) -> [u8; size_of::<Self>()] {

3688

            self.to_be().to_ne_bytes()

3689

3690

3691

        /// Returns the memory representation of this integer as a byte array in

3692

        /// little-endian byte order.

3693

///

3694

        #[doc = $to_xe_bytes_doc]

3695

///

3696

        /// # Examples

3697

///

3698

        /// ```

3699

        #[doc = concat!("let bytes = ", $swap_op, stringify!($SelfT), ".to_le_bytes();")]

3700

        #[doc = concat!("assert_eq!(bytes, ", $le_bytes, ");")]

3701

        /// ```

3702

        #[stable(feature = "int_to_from_bytes", since = "1.32.0")]

3703

        #[rustc_const_stable(feature = "const_int_conversion", since = "1.44.0")]

3704

        #[must_use = "this returns the result of the operation, \

3705

                      without modifying the original"]

3706

        #[inline]

3707

        #[cfg(not(feature = "ferrocene_certified"))]

3708

        pub const fn to_le_bytes(self) -> [u8; size_of::<Self>()] {

3709

            self.to_le().to_ne_bytes()

3710

3711

3712

        /// Returns the memory representation of this integer as a byte array in

3713

        /// native byte order.

3714

///

3715

        /// As the target platform's native endianness is used, portable code

3716

        /// should use [`to_be_bytes`] or [`to_le_bytes`], as appropriate,

3717

        /// instead.

3718

///

3719

        #[doc = $to_xe_bytes_doc]

3720

///

3721

        /// [`to_be_bytes`]: Self::to_be_bytes

3722

        /// [`to_le_bytes`]: Self::to_le_bytes

3723

///

3724

        /// # Examples

3725

///

3726

        /// ```

3727

        #[doc = concat!("let bytes = ", $swap_op, stringify!($SelfT), ".to_ne_bytes();")]

3728

        /// assert_eq!(

3729

        ///     bytes,

3730

        ///     if cfg!(target_endian = "big") {

3731

        #[doc = concat!("        ", $be_bytes)]

3732

        ///     } else {

3733

        #[doc = concat!("        ", $le_bytes)]

3734

        ///     }

3735

        /// );

3736

        /// ```

3737

        #[stable(feature = "int_to_from_bytes", since = "1.32.0")]

3738

        #[rustc_const_stable(feature = "const_int_conversion", since = "1.44.0")]

3739

        #[must_use = "this returns the result of the operation, \

3740

                      without modifying the original"]

3741

        #[allow(unnecessary_transmutes)]

3742

        // SAFETY: const sound because integers are plain old datatypes so we can always

3743

        // transmute them to arrays of bytes

3744

        #[inline]

3745

        #[cfg(not(feature = "ferrocene_certified"))]

3746

        pub const fn to_ne_bytes(self) -> [u8; size_of::<Self>()] {

3747

            // SAFETY: integers are plain old datatypes so we can always transmute them to

3748

            // arrays of bytes

3749

            unsafe { mem::transmute(self) }

3750

3751

3752

        /// Creates a native endian integer value from its representation

3753

        /// as a byte array in big endian.

3754

///

3755

        #[doc = $from_xe_bytes_doc]

3756

///

3757

        /// # Examples

3758

///

3759

        /// ```

3760

        #[doc = concat!("let value = ", stringify!($SelfT), "::from_be_bytes(", $be_bytes, ");")]

3761

        #[doc = concat!("assert_eq!(value, ", $swap_op, ");")]

3762

        /// ```

3763

///

3764

        /// When starting from a slice rather than an array, fallible conversion APIs can be used:

3765

///

3766

        /// ```

3767

        #[doc = concat!("fn read_be_", stringify!($SelfT), "(input: &mut &[u8]) -> ", stringify!($SelfT), " {")]

3768

        #[doc = concat!("    let (int_bytes, rest) = input.split_at(size_of::<", stringify!($SelfT), ">());")]

3769

        ///     *input = rest;

3770

        #[doc = concat!("    ", stringify!($SelfT), "::from_be_bytes(int_bytes.try_into().unwrap())")]

3771

        /// }

3772

        /// ```

3773

        #[stable(feature = "int_to_from_bytes", since = "1.32.0")]

3774

        #[rustc_const_stable(feature = "const_int_conversion", since = "1.44.0")]

3775

        #[must_use]

3776

        #[inline]

3777

        #[cfg(not(feature = "ferrocene_certified"))]

3778

        pub const fn from_be_bytes(bytes: [u8; size_of::<Self>()]) -> Self {

3779

            Self::from_be(Self::from_ne_bytes(bytes))

3780

3781

3782

        /// Creates a native endian integer value from its representation

3783

        /// as a byte array in little endian.

3784

///

3785

        #[doc = $from_xe_bytes_doc]

3786

///

3787

        /// # Examples

3788

///

3789

        /// ```

3790

        #[doc = concat!("let value = ", stringify!($SelfT), "::from_le_bytes(", $le_bytes, ");")]

3791

        #[doc = concat!("assert_eq!(value, ", $swap_op, ");")]

3792

        /// ```

3793

///

3794

        /// When starting from a slice rather than an array, fallible conversion APIs can be used:

3795

///

3796

        /// ```

3797

        #[doc = concat!("fn read_le_", stringify!($SelfT), "(input: &mut &[u8]) -> ", stringify!($SelfT), " {")]

3798

        #[doc = concat!("    let (int_bytes, rest) = input.split_at(size_of::<", stringify!($SelfT), ">());")]

3799

        ///     *input = rest;

3800

        #[doc = concat!("    ", stringify!($SelfT), "::from_le_bytes(int_bytes.try_into().unwrap())")]

3801

        /// }

3802

        /// ```

3803

        #[stable(feature = "int_to_from_bytes", since = "1.32.0")]

3804

        #[rustc_const_stable(feature = "const_int_conversion", since = "1.44.0")]

3805

        #[must_use]

3806

        #[inline]

3807

        #[cfg(not(feature = "ferrocene_certified"))]

3808

        pub const fn from_le_bytes(bytes: [u8; size_of::<Self>()]) -> Self {

3809

            Self::from_le(Self::from_ne_bytes(bytes))

3810

3811

3812

        /// Creates a native endian integer value from its memory representation

3813

        /// as a byte array in native endianness.

3814

///

3815

        /// As the target platform's native endianness is used, portable code

3816

        /// likely wants to use [`from_be_bytes`] or [`from_le_bytes`], as

3817

        /// appropriate instead.

3818

///

3819

        /// [`from_be_bytes`]: Self::from_be_bytes

3820

        /// [`from_le_bytes`]: Self::from_le_bytes

3821

///

3822

        #[doc = $from_xe_bytes_doc]

3823

///

3824

        /// # Examples

3825

///

3826

        /// ```

3827

        #[doc = concat!("let value = ", stringify!($SelfT), "::from_ne_bytes(if cfg!(target_endian = \"big\") {")]

3828

        #[doc = concat!("    ", $be_bytes, "")]

3829

        /// } else {

3830

        #[doc = concat!("    ", $le_bytes, "")]

3831

        /// });

3832

        #[doc = concat!("assert_eq!(value, ", $swap_op, ");")]

3833

        /// ```

3834

///

3835

        /// When starting from a slice rather than an array, fallible conversion APIs can be used:

3836

///

3837

        /// ```

3838

        #[doc = concat!("fn read_ne_", stringify!($SelfT), "(input: &mut &[u8]) -> ", stringify!($SelfT), " {")]

3839

        #[doc = concat!("    let (int_bytes, rest) = input.split_at(size_of::<", stringify!($SelfT), ">());")]

3840

        ///     *input = rest;

3841

        #[doc = concat!("    ", stringify!($SelfT), "::from_ne_bytes(int_bytes.try_into().unwrap())")]

3842

        /// }

3843

        /// ```

3844

        #[stable(feature = "int_to_from_bytes", since = "1.32.0")]

3845

        #[rustc_const_stable(feature = "const_int_conversion", since = "1.44.0")]

3846

        #[allow(unnecessary_transmutes)]

3847

        #[must_use]

3848

        // SAFETY: const sound because integers are plain old datatypes so we can always

3849

        // transmute to them

3850

        #[inline]

3851

        #[cfg(not(feature = "ferrocene_certified"))]

3852

        pub const fn from_ne_bytes(bytes: [u8; size_of::<Self>()]) -> Self {

3853

            // SAFETY: integers are plain old datatypes so we can always transmute to them

3854

            unsafe { mem::transmute(bytes) }

3855

3856

3857

        /// New code should prefer to use

3858

        #[doc = concat!("[`", stringify!($SelfT), "::MIN", "`] instead.")]

3859

///

3860

        /// Returns the smallest value that can be represented by this integer type.

3861

        #[stable(feature = "rust1", since = "1.0.0")]

3862

        #[rustc_promotable]

3863

        #[inline(always)]

3864

        #[rustc_const_stable(feature = "const_max_value", since = "1.32.0")]

3865

        #[deprecated(since = "TBD", note = "replaced by the `MIN` associated constant on this type")]

3866

        #[rustc_diagnostic_item = concat!(stringify!($SelfT), "_legacy_fn_min_value")]

3867

        #[cfg(not(feature = "ferrocene_certified"))]

3868

        pub const fn min_value() -> Self { Self::MIN }

3869

3870

        /// New code should prefer to use

3871

        #[doc = concat!("[`", stringify!($SelfT), "::MAX", "`] instead.")]

3872

///

3873

        /// Returns the largest value that can be represented by this integer type.

3874

        #[stable(feature = "rust1", since = "1.0.0")]

3875

        #[rustc_promotable]

3876

        #[inline(always)]

3877

        #[rustc_const_stable(feature = "const_max_value", since = "1.32.0")]

3878

        #[deprecated(since = "TBD", note = "replaced by the `MAX` associated constant on this type")]

3879

        #[rustc_diagnostic_item = concat!(stringify!($SelfT), "_legacy_fn_max_value")]

3880

        #[cfg(not(feature = "ferrocene_certified"))]

3881

        pub const fn max_value() -> Self { Self::MAX }

3882

3883