github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/x/unsafe/rand.go (about)

     1  // Copyright (c) 2020 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  // Package unsafe contains operations that step around the type safety of Go programs.
    22  package unsafe
    23  
    24  import (
    25  	_ "unsafe" // needed for go:linkname hack
    26  )
    27  
    28  //go:linkname fastrand runtime.fastrand
    29  func fastrand() uint32
    30  
    31  // Fastrandn returns a uint32 in range of 0..n, like rand() % n, but faster not as precise,
    32  // https://lemire.me/blog/2016/06/27/a-fast-alternative-to-the-modulo-reduction/
    33  func Fastrandn(n uint32) uint32 {
    34  	// This is similar to fastrand() % n, but faster.
    35  	return uint32(uint64(fastrand()) * uint64(n) >> 32)
    36  }