github.com/m3db/m3@v1.5.0/src/cluster/placement/algo/algo.go

// Copyright (c) 2016 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 algo implements different types of placement algorithms
package algo

import (
	"github.com/m3db/m3/src/cluster/placement"
)

// NewAlgorithm returns a placement algorithm with given options
func NewAlgorithm(opts placement.Options) placement.Algorithm {
	if opts == nil {
		opts = placement.NewOptions()
	}
	if opts.IsMirrored() {
		return newMirroredAlgorithm(opts)
	}

	if opts.IsSharded() {
		return newShardedAlgorithm(opts)
	}

	return newNonShardedAlgorithm()
}