github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/x/hash/jump/doc.go

// Copyright (c) 2017 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

/*

Package jump implements the jump consistent hash algorithm as described in
"A Fast, Minimal Memory, Consistent Hash Algorithm"[1]. As the paper notes:
"In comparison to the algorithm of Karger et al., jump consistent hash
requires no storage, is faster, and does a better job of evenly dividing
the key space among the buckets and of evenly dividing the workload when
the number of buckets changes. Its main limitation is that the buckets
must be numbered sequentially, which makes it more suitable for data
storage applications than for distributed web caching."

[1] http://arxiv.org/pdf/1406.2294v1.pdf

*/
package jump