pax_global_header00006660000000000000000000000064151532105230014507gustar00rootroot0000000000000052 comment=eec5afcc8fb24a3b49144fff50ed5469a0000c29 golang-github-zeebo-pcg-1.0.1/000077500000000000000000000000001515321052300161065ustar00rootroot00000000000000golang-github-zeebo-pcg-1.0.1/LICENSE000066400000000000000000000160251515321052300171170ustar00rootroot00000000000000This work is released into the public domain with CC0 1.0. ------------------------------------------------------------------------------- Creative Commons Legal Code CC0 1.0 Universal CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED HEREUNDER. Statement of Purpose The laws of most jurisdictions throughout the world automatically confer exclusive Copyright and Related Rights (defined below) upon the creator and subsequent owner(s) (each and all, an "owner") of an original work of authorship and/or a database (each, a "Work"). Certain owners wish to permanently relinquish those rights to a Work for the purpose of contributing to a commons of creative, cultural and scientific works ("Commons") that the public can reliably and without fear of later claims of infringement build upon, modify, incorporate in other works, reuse and redistribute as freely as possible in any form whatsoever and for any purposes, including without limitation commercial purposes. These owners may contribute to the Commons to promote the ideal of a free culture and the further production of creative, cultural and scientific works, or to gain reputation or greater distribution for their Work in part through the use and efforts of others. For these and/or other purposes and motivations, and without any expectation of additional consideration or compensation, the person associating CC0 with a Work (the "Affirmer"), to the extent that he or she is an owner of Copyright and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and publicly distribute the Work under its terms, with knowledge of his or her Copyright and Related Rights in the Work and the meaning and intended legal effect of CC0 on those rights. 1. Copyright and Related Rights. A Work made available under CC0 may be protected by copyright and related or neighboring rights ("Copyright and Related Rights"). Copyright and Related Rights include, but are not limited to, the following: i. the right to reproduce, adapt, distribute, perform, display, communicate, and translate a Work; ii. moral rights retained by the original author(s) and/or performer(s); iii. publicity and privacy rights pertaining to a person's image or likeness depicted in a Work; iv. rights protecting against unfair competition in regards to a Work, subject to the limitations in paragraph 4(a), below; v. rights protecting the extraction, dissemination, use and reuse of data in a Work; vi. database rights (such as those arising under Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, and under any national implementation thereof, including any amended or successor version of such directive); and vii. other similar, equivalent or corresponding rights throughout the world based on applicable law or treaty, and any national implementations thereof. 2. Waiver. To the greatest extent permitted by, but not in contravention of, applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and unconditionally waives, abandons, and surrenders all of Affirmer's Copyright and Related Rights and associated claims and causes of action, whether now known or unknown (including existing as well as future claims and causes of action), in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each member of the public at large and to the detriment of Affirmer's heirs and successors, fully intending that such Waiver shall not be subject to revocation, rescission, cancellation, termination, or any other legal or equitable action to disrupt the quiet enjoyment of the Work by the public as contemplated by Affirmer's express Statement of Purpose. 3. Public License Fallback. Should any part of the Waiver for any reason be judged legally invalid or ineffective under applicable law, then the Waiver shall be preserved to the maximum extent permitted taking into account Affirmer's express Statement of Purpose. In addition, to the extent the Waiver is so judged Affirmer hereby grants to each affected person a royalty-free, non transferable, non sublicensable, non exclusive, irrevocable and unconditional license to exercise Affirmer's Copyright and Related Rights in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "License"). The License shall be deemed effective as of the date CC0 was applied by Affirmer to the Work. Should any part of the License for any reason be judged legally invalid or ineffective under applicable law, such partial invalidity or ineffectiveness shall not invalidate the remainder of the License, and in such case Affirmer hereby affirms that he or she will not (i) exercise any of his or her remaining Copyright and Related Rights in the Work or (ii) assert any associated claims and causes of action with respect to the Work, in either case contrary to Affirmer's express Statement of Purpose. 4. Limitations and Disclaimers. a. No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, licensed or otherwise affected by this document. b. Affirmer offers the Work as-is and makes no representations or warranties of any kind concerning the Work, express, implied, statutory or otherwise, including without limitation warranties of title, merchantability, fitness for a particular purpose, non infringement, or the absence of latent or other defects, accuracy, or the present or absence of errors, whether or not discoverable, all to the greatest extent permissible under applicable law. c. Affirmer disclaims responsibility for clearing rights of other persons that may apply to the Work or any use thereof, including without limitation any person's Copyright and Related Rights in the Work. Further, Affirmer disclaims responsibility for obtaining any necessary consents, permissions or other rights required for any use of the Work. d. Affirmer understands and acknowledges that Creative Commons is not a party to this document and has no duty or obligation with respect to this CC0 or use of the Work. golang-github-zeebo-pcg-1.0.1/README.txt000066400000000000000000000042141515321052300176050ustar00rootroot00000000000000PACKAGE DOCUMENTATION package pcg import "github.com/zeebo/pcg" FUNCTIONS func Float32() float32 Float32 returns a float32 uniformly in [0, 1). Safe for concurrent callers. func Float64() float64 Float64 returns a float64 uniformly in [0, 1). Safe for concurrent callers. func Uint32() uint32 Uint32 returns a random uint32. Safe for concurrent callers. func Uint32n(n uint32) uint32 Uint32n returns a uint32 uniformly in [0, n). Safe for concurrent callers. func Uint64() uint64 Uint64 returns a random uint64. Safe for concurrent callers. TYPES type PT struct { // contains filtered or unexported fields } PT is a thread safe pcg generator. The output is non-deterministic, even if all of the calls are single threaded. The zero value is valid. func NewParallel(state uint64) PT New constructs a parallel pcg with the given state. func (p *PT) Float32() float32 Float32 returns a float32 uniformly in [0, 1). Safe for concurrent callers. func (p *PT) Float64() float64 Float64 returns a float64 uniformly in [0, 1). Safe for concurrent callers. func (p *PT) Uint32() uint32 Uint32 returns a random uint32. Safe for concurrent callers. func (p *PT) Uint32n(n uint32) uint32 Uint32n returns a uint32 uniformly in [0, n). Safe for concurrent callers. func (p *PT) Uint64() uint64 Uint64 returns a random uint64. Safe for concurrent callers. type T struct { // contains filtered or unexported fields } T is a pcg generator. The zero value is valid. func New(state uint64) T New constructs a pcg with the given state. func (p *T) Float32() float32 Float32 returns a float32 uniformly in [0, 1). Not safe for concurrent callers. func (p *T) Float64() float64 Float64 returns a float64 uniformly in [0, 1). Not safe for concurrent callers. func (p *T) Uint32() uint32 Uint32 returns a random uint32. Not safe for concurrent callers. func (p *T) Uint32n(n uint32) uint32 Uint32n returns a uint32 uniformly in [0, n). Not safe for concurrent callers. func (p *T) Uint64() uint64 Uint64 returns a random uint64. Not safe for concurrent callers. golang-github-zeebo-pcg-1.0.1/go.mod000066400000000000000000000001151515321052300172110ustar00rootroot00000000000000module github.com/zeebo/pcg require github.com/zeebo/assert v1.1.0 go 1.13 golang-github-zeebo-pcg-1.0.1/go.sum000066400000000000000000000002451515321052300172420ustar00rootroot00000000000000github.com/zeebo/assert v1.1.0 h1:hU1L1vLTHsnO8x8c9KAR5GmM5QscxHg5RNU5z5qbUWY= github.com/zeebo/assert v1.1.0/go.mod h1:Pq9JiuJQpG8JLJdtkwrJESF0Foym2/D9XMU5ciN/wJ0= golang-github-zeebo-pcg-1.0.1/package.go000066400000000000000000000035211515321052300200310ustar00rootroot00000000000000package pcg // global is a parallel pcg for the package functions. var global PT // Uint32 returns a random uint32. // Safe for concurrent callers. func Uint32() uint32 { state := global.next() xor := uint32(((state >> 18) ^ state) >> 27) shift := uint(state>>59) & 31 return xor>>shift | xor<<(32-shift) } // Uint32n returns a uint32 uniformly in [0, n). // Safe for concurrent callers. func Uint32n(n uint32) uint32 { if n == 0 { return 0 } x := global.Uint32() m := uint64(x) * uint64(n) l := uint32(m) if l < n { t := -n if t >= n { t -= n if t >= n { t = t % n } } again: if l < t { x = global.Uint32() m = uint64(x) * uint64(n) l = uint32(m) goto again } } return uint32(m >> 32) } // Uint64 returns a random uint64. // Safe for concurrent callers. func Uint64() uint64 { state1 := global.next() state2 := global.next() xor1 := uint32(((state1 >> 18) ^ state1) >> 27) shift1 := uint(state1>>59) & 31 xor2 := uint32(((state2 >> 18) ^ state2) >> 27) shift2 := uint(state2>>59) & 31 return uint64(xor1>>shift1|xor1<<(32-shift1))<<32 | uint64(xor2>>shift2|xor2<<(32-shift2)) } // Float64 returns a float64 uniformly in [0, 1). // Safe for concurrent callers. func Float64() float64 { again: state1 := global.next() state2 := global.next() xor1 := uint32(((state1 >> 18) ^ state1) >> 27) shift1 := uint(state1>>59) & 31 xor2 := uint32(((state2 >> 18) ^ state2) >> 27) shift2 := uint(state2>>59) & 31 v := uint64(xor1>>shift1|xor1<<(32-shift1)) | uint64(xor2>>shift2|xor2<<(32-shift2)) out := float64(v>>(64-53)) / (1 << 53) if out == 1 { goto again } return out } // Float32 returns a float32 uniformly in [0, 1). // Safe for concurrent callers. func Float32() float32 { again: out := float32(global.Uint32()>>(32-24)) / (1 << 24) if out == 1 { goto again } return out } golang-github-zeebo-pcg-1.0.1/par_pcg.go000066400000000000000000000055241515321052300200560ustar00rootroot00000000000000package pcg import "sync/atomic" // PT is a thread safe pcg generator. The output is non-deterministic, even // if all of the calls are single threaded. The zero value is valid. type PT struct { state [8]struct { v uint64 _ [120]byte // pad to two cache lines } } // independent incs for each state var parInc = [...]uint64{ 0x0105c7f8e6e4c8e1, 0xdd8a45d4a7d3e08e, 0x8687c0717abf0fce, 0xfdd14f7a53ba7c6e, 0xd73bd47d3c1f77f4, 0xb73f1ab0cfeaf544, 0x97a106a20fb5466c, 0xe07d6876e401a906, } // New constructs a parallel pcg with the given state. func NewParallel(state uint64) PT { var pt PT pt.state[0].v = state + 0 pt.state[1].v = state + 1 pt.state[2].v = state + 2 pt.state[3].v = state + 3 pt.state[4].v = state + 4 pt.state[5].v = state + 5 pt.state[6].v = state + 6 pt.state[7].v = state + 7 return pt } // next advances and returns the state. func (p *PT) next() uint64 { again: index := tid() & 7 orig := atomic.LoadUint64(&p.state[index].v) next := orig*mul + parInc[index] if atomic.CompareAndSwapUint64(&p.state[index].v, orig, next) { return next } goto again } // Uint32 returns a random uint32. // Safe for concurrent callers. func (p *PT) Uint32() uint32 { state := p.next() xor := uint32(((state >> 18) ^ state) >> 27) shift := uint(state>>59) & 31 return xor>>shift | xor<<(32-shift) } // Uint32n returns a uint32 uniformly in [0, n). // Safe for concurrent callers. func (p *PT) Uint32n(n uint32) uint32 { if n == 0 { return 0 } x := p.Uint32() m := uint64(x) * uint64(n) l := uint32(m) if l < n { t := -n if t >= n { t -= n if t >= n { t = t % n } } again: if l < t { x = p.Uint32() m = uint64(x) * uint64(n) l = uint32(m) goto again } } return uint32(m >> 32) } // Uint64 returns a random uint64. // Safe for concurrent callers. func (p *PT) Uint64() uint64 { state1 := p.next() state2 := p.next() xor1 := uint32(((state1 >> 18) ^ state1) >> 27) shift1 := uint(state1>>59) & 31 xor2 := uint32(((state2 >> 18) ^ state2) >> 27) shift2 := uint(state2>>59) & 31 return uint64(xor1>>shift1|xor1<<(32-shift1))<<32 | uint64(xor2>>shift2|xor2<<(32-shift2)) } // Float64 returns a float64 uniformly in [0, 1). // Safe for concurrent callers. func (p *PT) Float64() float64 { again: state1 := p.next() state2 := p.next() xor1 := uint32(((state1 >> 18) ^ state1) >> 27) shift1 := uint(state1>>59) & 31 xor2 := uint32(((state2 >> 18) ^ state2) >> 27) shift2 := uint(state2>>59) & 31 v := uint64(xor1>>shift1|xor1<<(32-shift1)) | uint64(xor2>>shift2|xor2<<(32-shift2)) out := float64(v>>(64-53)) / (1 << 53) if out == 1 { goto again } return out } // Float32 returns a float32 uniformly in [0, 1). // Safe for concurrent callers. func (p *PT) Float32() float32 { again: out := float32(p.Uint32()>>(32-24)) / (1 << 24) if out == 1 { goto again } return out } golang-github-zeebo-pcg-1.0.1/par_pcg_test.go000066400000000000000000000051031515321052300211060ustar00rootroot00000000000000package pcg import "testing" func BenchmarkParPCG(b *testing.B) { b.Run("Single", func(b *testing.B) { b.Run("Uint32", func(b *testing.B) { rng := NewParallel(2345) for i := 0; i < b.N; i++ { blackholeUint32 += rng.Uint32() } }) b.Run("Uint32n", func(b *testing.B) { b.Run("Large", func(b *testing.B) { rng := NewParallel(2345) for i := 0; i < b.N; i++ { blackholeUint32 += rng.Uint32n(1<<31 + 1) } }) b.Run("Small", func(b *testing.B) { rng := NewParallel(2345) for i := 0; i < b.N; i++ { blackholeUint32 += rng.Uint32n(1000) } }) }) b.Run("Uint64", func(b *testing.B) { rng := NewParallel(2345) for i := 0; i < b.N; i++ { blackholeUint64 += rng.Uint64() } }) b.Run("Float64", func(b *testing.B) { rng := NewParallel(2345) for i := 0; i < b.N; i++ { blackholeFloat64 += rng.Float64() } }) b.Run("Float32", func(b *testing.B) { rng := NewParallel(2345) for i := 0; i < b.N; i++ { blackholeFloat32 += rng.Float32() } }) }) b.Run("Parallel", func(b *testing.B) { b.Run("Uint32", func(b *testing.B) { rng := NewParallel(2345) b.RunParallel(func(pb *testing.PB) { var localUint32 uint32 for pb.Next() { localUint32 += rng.Uint32() } blackholeUint32 += localUint32 }) }) b.Run("Uint32n", func(b *testing.B) { b.Run("Large", func(b *testing.B) { rng := NewParallel(2345) b.RunParallel(func(pb *testing.PB) { var localUint32 uint32 for pb.Next() { localUint32 += rng.Uint32n(1<<31 + 1) } blackholeUint32 += localUint32 }) }) b.Run("Small", func(b *testing.B) { rng := NewParallel(2345) b.RunParallel(func(pb *testing.PB) { var localUint32 uint32 for pb.Next() { localUint32 += rng.Uint32n(1000) } blackholeUint32 += localUint32 }) }) }) b.Run("Uint64", func(b *testing.B) { rng := NewParallel(2345) b.RunParallel(func(pb *testing.PB) { var localUint64 uint64 for pb.Next() { localUint64 += rng.Uint64() } blackholeUint64 += localUint64 }) }) b.Run("Float64", func(b *testing.B) { rng := NewParallel(2345) b.RunParallel(func(pb *testing.PB) { var localFloat64 float64 for pb.Next() { localFloat64 += rng.Float64() } blackholeFloat64 += localFloat64 }) }) b.Run("Float32", func(b *testing.B) { rng := NewParallel(2345) b.RunParallel(func(pb *testing.PB) { var localFloat32 float32 for pb.Next() { localFloat32 += rng.Float32() } blackholeFloat32 += localFloat32 }) }) }) } golang-github-zeebo-pcg-1.0.1/pcg.go000066400000000000000000000043141515321052300172100ustar00rootroot00000000000000package pcg // T is a pcg generator. The zero value is valid. type T struct{ state uint64 } // mul is the multiplier for the LCG step. const ( mul = 6364136223846793005 inc = 11981177638785157926 ) // New constructs a pcg with the given state. func New(state uint64) T { return T{state} } // next advances and returns the state. // Not safe for concurrent callers. func (p *T) next() uint64 { p.state = p.state*mul + inc return p.state } // Uint32 returns a random uint32. // Not safe for concurrent callers. func (p *T) Uint32() uint32 { state := p.next() xor := uint32(((state >> 18) ^ state) >> 27) shift := uint(state>>59) & 31 return xor>>shift | xor<<(32-shift) } // Uint32n returns a uint32 uniformly in [0, n). // Not safe for concurrent callers. func (p *T) Uint32n(n uint32) uint32 { if n == 0 { return 0 } x := p.Uint32() m := uint64(x) * uint64(n) l := uint32(m) if l < n { t := -n if t >= n { t -= n if t >= n { t = t % n } } again: if l < t { x = p.Uint32() m = uint64(x) * uint64(n) l = uint32(m) goto again } } return uint32(m >> 32) } // Uint64 returns a random uint64. // Not safe for concurrent callers. func (p *T) Uint64() uint64 { state1 := p.next() state2 := p.next() xor1 := uint32(((state1 >> 18) ^ state1) >> 27) shift1 := uint(state1>>59) & 31 xor2 := uint32(((state2 >> 18) ^ state2) >> 27) shift2 := uint(state2>>59) & 31 return uint64(xor1>>shift1|xor1<<(32-shift1))<<32 | uint64(xor2>>shift2|xor2<<(32-shift2)) } // Float64 returns a float64 uniformly in [0, 1). // Not safe for concurrent callers. func (p *T) Float64() float64 { again: state1 := p.next() state2 := p.next() xor1 := uint32(((state1 >> 18) ^ state1) >> 27) shift1 := uint(state1>>59) & 31 xor2 := uint32(((state2 >> 18) ^ state2) >> 27) shift2 := uint(state2>>59) & 31 v := uint64(xor1>>shift1|xor1<<(32-shift1)) | uint64(xor2>>shift2|xor2<<(32-shift2)) out := float64(v>>(64-53)) / (1 << 53) if out == 1 { goto again } return out } // Float32 returns a float32 uniformly in [0, 1). // Not safe for concurrent callers. func (p *T) Float32() float32 { again: out := float32(p.Uint32()>>(32-24)) / (1 << 24) if out == 1 { goto again } return out } golang-github-zeebo-pcg-1.0.1/pcg_test.go000066400000000000000000000026271515321052300202540ustar00rootroot00000000000000package pcg import ( "testing" "github.com/zeebo/assert" ) func TestPCG(t *testing.T) { t.Run("Matches", func(t *testing.T) { rng := New(2345) out := make([]uint32, 10) for i := range out { out[i] = rng.Uint32() } assert.DeepEqual(t, out, []uint32{ 0x4fb93cfb, 0x7f1f4c1e, 0x9d253788, 0x424b17a2, 0x41f308c7, 0x847fd9fc, 0x4aa51433, 0x9f72ee73, 0x57cb76b4, 0x8ba782bc, }) }) } var ( blackholeUint32 uint32 blackholeUint64 uint64 blackholeFloat32 float32 blackholeFloat64 float64 ) func BenchmarkPCG(b *testing.B) { b.Run("Uint32", func(b *testing.B) { rng := New(2345) for i := 0; i < b.N; i++ { blackholeUint32 += rng.Uint32() } }) b.Run("Uint32n", func(b *testing.B) { b.Run("Large", func(b *testing.B) { rng := New(2345) for i := 0; i < b.N; i++ { blackholeUint32 += rng.Uint32n(1<<31 + 1) } }) b.Run("Small", func(b *testing.B) { rng := New(2345) for i := 0; i < b.N; i++ { blackholeUint32 += rng.Uint32n(1000) } }) }) b.Run("Uint64", func(b *testing.B) { rng := New(2345) for i := 0; i < b.N; i++ { blackholeUint64 += rng.Uint64() } }) b.Run("Float64", func(b *testing.B) { rng := New(2345) for i := 0; i < b.N; i++ { blackholeFloat64 += rng.Float64() } }) b.Run("Float32", func(b *testing.B) { rng := New(2345) for i := 0; i < b.N; i++ { blackholeFloat32 += rng.Float32() } }) } golang-github-zeebo-pcg-1.0.1/tid.go000066400000000000000000000007141515321052300172170ustar00rootroot00000000000000package pcg import ( "sync" "sync/atomic" ) // a poor man's thread id. use the fact that sync.Pool has some affinity to return // a counter that should stay the same between calls. it's up to you to turn this // counter into something useful. var ( tidCounter uint64 tidPool = sync.Pool{New: func() interface{} { return atomic.AddUint64(&tidCounter, 1) }} ) func tid() (v uint64) { x := tidPool.Get() tidPool.Put(x) v, _ = x.(uint64) return v } golang-github-zeebo-pcg-1.0.1/tid_test.go000066400000000000000000000004711515321052300202560ustar00rootroot00000000000000package pcg import "testing" func BenchmarkTID(b *testing.B) { b.Run("Single", func(b *testing.B) { b.ReportAllocs() for i := 0; i < b.N; i++ { tid() } }) b.Run("Parallel", func(b *testing.B) { b.ReportAllocs() b.RunParallel(func(pb *testing.PB) { for pb.Next() { tid() } }) }) }