github.com/m3db/m3@v1.5.0/src/dbnode/namespace/aggregation.go (about)

     1  // Copyright (c) 2020  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 namespace
    22  
    23  import (
    24  	"fmt"
    25  	"time"
    26  )
    27  
    28  type aggregationOptions struct {
    29  	aggregations []Aggregation
    30  }
    31  
    32  // NewAggregationOptions creates new AggregationOptions.
    33  func NewAggregationOptions() AggregationOptions {
    34  	return &aggregationOptions{}
    35  }
    36  
    37  func (a *aggregationOptions) SetAggregations(value []Aggregation) AggregationOptions {
    38  	opts := *a
    39  	opts.aggregations = value
    40  	return &opts
    41  }
    42  
    43  func (a *aggregationOptions) Aggregations() []Aggregation {
    44  	return a.aggregations
    45  }
    46  
    47  func (a *aggregationOptions) Equal(rhs AggregationOptions) bool {
    48  	if len(a.aggregations) != len(rhs.Aggregations()) {
    49  		return false
    50  	}
    51  
    52  	for i, agg := range rhs.Aggregations() {
    53  		if a.aggregations[i] != agg {
    54  			return false
    55  		}
    56  	}
    57  
    58  	return true
    59  }
    60  
    61  // NewUnaggregatedAggregation creates a new unaggregated Aggregation.
    62  func NewUnaggregatedAggregation() Aggregation {
    63  	return Aggregation{
    64  		Aggregated: false,
    65  	}
    66  }
    67  
    68  // NewAggregatedAggregation creates a new aggregated Aggregation.
    69  func NewAggregatedAggregation(attrs AggregatedAttributes) Aggregation {
    70  	return Aggregation{
    71  		Aggregated: true,
    72  		Attributes: attrs,
    73  	}
    74  }
    75  
    76  // NewAggregateAttributes creates new AggregatedAttributes.
    77  func NewAggregatedAttributes(resolution time.Duration, downsampleOptions DownsampleOptions) (AggregatedAttributes, error) {
    78  	if resolution <= 0 {
    79  		return AggregatedAttributes{}, fmt.Errorf("invalid resolution %v. must be greater than 0", resolution)
    80  	}
    81  	return AggregatedAttributes{
    82  		Resolution:        resolution,
    83  		DownsampleOptions: downsampleOptions,
    84  	}, nil
    85  }
    86  
    87  // NewDownsampleOptions creates new DownsampleOptions.
    88  func NewDownsampleOptions(all bool) DownsampleOptions {
    89  	return DownsampleOptions{All: all}
    90  }