github.com/m3db/m3@v1.5.0/src/dbnode/storage/index/aggregate_values_new_map.go (about)

     1  // Copyright (c) 2019 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 index
    22  
    23  import (
    24  	"github.com/m3db/m3/src/x/ident"
    25  
    26  	"github.com/cespare/xxhash/v2"
    27  )
    28  
    29  const (
    30  	defaultInitialAggregatedValuesMapSize = 10
    31  )
    32  
    33  // NewAggregateValuesMap builds an AggregateValuesMap, which is primarily used
    34  // for checking for existence of particular ident.IDs.
    35  func NewAggregateValuesMap(idPool ident.Pool) *AggregateValuesMap {
    36  	return _AggregateValuesMapAlloc(_AggregateValuesMapOptions{
    37  		hash: func(k ident.ID) AggregateValuesMapHash {
    38  			return AggregateValuesMapHash(xxhash.Sum64(k.Bytes()))
    39  		},
    40  		equals: func(x, y ident.ID) bool {
    41  			return x.Equal(y)
    42  		},
    43  		copy: func(k ident.ID) ident.ID {
    44  			return idPool.Clone(k)
    45  		},
    46  		finalize: func(k ident.ID) {
    47  			k.Finalize()
    48  		},
    49  		initialSize: defaultInitialAggregatedValuesMapSize,
    50  	})
    51  }