knative.dev/pkg@v0.0.0-20260602142205-ac97e43f6622/hash/doc.go (about)

     1  /*
     2  Copyright 2020 The Knative Authors
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      https://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  // Package hash contains various Knative specific hashing utilities.
    18  //
    19  //   - ChooseSubset is a consistent hashing/mapping function providing
    20  //     a consistent selection of N keys from M (N<=M) keys for a given
    21  //     target.
    22  //   - BucketSet is a bucketer library which uses ChooseSubset under the
    23  //     the hood in order to implement consistent mapping between keys and
    24  //     set of buckets, identified by unique names. Compared to basic bucket
    25  //     implementation which just does hash%num_buckets, when the number of
    26  //     buckets change only a small subset of keys are supposed to migrate.
    27  package hash