github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/aggregator/aggregation/quantile/cm/options.go (about)

     1  // Copyright (c) 2016 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 cm
    22  
    23  import (
    24  	"fmt"
    25  )
    26  
    27  const (
    28  	minEps                        = 0.0
    29  	maxEps                        = 0.5
    30  	defaultEps                    = 1e-3
    31  	defaultCapacity               = 32
    32  	defaultInsertAndCompressEvery = 1024
    33  )
    34  
    35  var (
    36  	errInvalidEps = fmt.Errorf("epsilon value must be between %f and %f", minEps, maxEps)
    37  )
    38  
    39  type options struct {
    40  	streamPool             StreamPool
    41  	eps                    float64
    42  	capacity               int
    43  	insertAndCompressEvery int
    44  }
    45  
    46  // NewOptions creates a new options.
    47  func NewOptions() Options {
    48  	o := &options{
    49  		eps:                    defaultEps,
    50  		capacity:               defaultCapacity,
    51  		insertAndCompressEvery: defaultInsertAndCompressEvery,
    52  	}
    53  	o.streamPool = NewStreamPool(o)
    54  	return o
    55  }
    56  
    57  func (o *options) SetEps(value float64) Options {
    58  	o.eps = value
    59  	return o
    60  }
    61  
    62  func (o *options) Eps() float64 {
    63  	return o.eps
    64  }
    65  
    66  func (o *options) SetCapacity(value int) Options {
    67  	o.capacity = value
    68  	return o
    69  }
    70  
    71  func (o *options) Capacity() int {
    72  	return o.capacity
    73  }
    74  
    75  func (o *options) SetInsertAndCompressEvery(value int) Options {
    76  	o.insertAndCompressEvery = value
    77  	return o
    78  }
    79  
    80  func (o *options) InsertAndCompressEvery() int {
    81  	return o.insertAndCompressEvery
    82  }
    83  
    84  func (o *options) SetStreamPool(value StreamPool) Options {
    85  	o.streamPool = value
    86  	return o
    87  }
    88  
    89  func (o *options) StreamPool() StreamPool {
    90  	return o.streamPool
    91  }
    92  
    93  func (o *options) Validate() error {
    94  	if o.eps <= minEps || o.eps >= maxEps {
    95  		return errInvalidEps
    96  	}
    97  
    98  	return nil
    99  }