File: Math.swift

package info (click to toggle)
swiftlang 6.2.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,856,264 kB
  • sloc: cpp: 9,995,718; ansic: 2,234,019; asm: 1,092,167; python: 313,940; objc: 82,726; f90: 80,126; lisp: 38,373; pascal: 25,580; sh: 20,378; ml: 5,058; perl: 4,751; makefile: 4,725; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (48 lines) | stat: -rw-r--r-- 1,709 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2025 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

/// Common math and bit-wise operations
public extension Int {
    /// Returns the value with the least-significant bit removed.
    func withoutLSB() -> Int {
        return self & (self - 1)
    }

    /// Check if the value is a power-of-two.
    func isPowerOfTwo() -> Bool {
        // A value is a power of two if it isn't zero and removing one bit makes it zero.
        return self != 0 && withoutLSB() == 0
    }

    /// Return the next larger power-of-two, or 0 on overflow.
    func nextPowerOfTwo() -> Int {
        // Compute the next power of two by filling all bits below the MSB, then adding one.
        var result = self
        result |= result >> 1
        result |= result >> 2
        result |= result >> 4
        result |= result >> 8
        result |= result >> 16
        result |= result >> 32
        return result + 1
    }

    /// Return the smallest power-of-two greater than or equal to the value.
    func roundUpToPowerOfTwo() -> Int {
        return isPowerOfTwo() ? self : nextPowerOfTwo()
    }

    /// Returns the smallest even number greater than or equal to the value.
    func nextEvenNumber() -> Int {
        return self % 2 == 0 ? self : self + 1
    }
}