gods/sets/treeset/treeset.go
2017-02-26 20:20:24 -06:00

109 lines
2.8 KiB
Go

// Copyright (c) 2015, Emir Pasic. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Package treeset implements a tree backed by a red-black tree.
//
// Structure is not thread safe.
//
// Reference: http://en.wikipedia.org/wiki/Set_%28abstract_data_type%29
package treeset
import (
"fmt"
"strings"
"github.com/emirpasic/gods/sets"
"github.com/emirpasic/gods/trees"
rbt "github.com/emirpasic/gods/trees/redblacktree"
"github.com/emirpasic/gods/utils"
)
func assertSetImplementation() {
var _ sets.Set = (*Set)(nil)
}
// Set holds elements in a red-black tree
type Set struct {
tree trees.Tree
}
var itemExists = struct{}{}
// NewWith instantiates a new empty set with the custom comparator.
func NewWith(comparator utils.Comparator) *Set {
return &Set{tree: rbt.NewWith(comparator)}
}
// NewWithIntComparator instantiates a new empty set with the IntComparator, i.e. keys are of type int.
func NewWithIntComparator() *Set {
return &Set{tree: rbt.NewWithIntComparator()}
}
// NewWithStringComparator instantiates a new empty set with the StringComparator, i.e. keys are of type string.
func NewWithStringComparator() *Set {
return &Set{tree: rbt.NewWithStringComparator()}
}
// NewWithTree instantiates a new empty set with given tree
func NewWithTree(tree trees.Tree) *Set {
return &Set{tree: tree}
}
// Add adds the items (one or more) to the set.
func (set *Set) Add(items ...interface{}) {
for _, item := range items {
set.tree.Put(item, itemExists)
}
}
// Remove removes the items (one or more) from the set.
func (set *Set) Remove(items ...interface{}) {
for _, item := range items {
set.tree.Remove(item)
}
}
// Contains checks weather items (one or more) are present in the set.
// All items have to be present in the set for the method to return true.
// Returns true if no arguments are passed at all, i.e. set is always superset of empty set.
func (set *Set) Contains(items ...interface{}) bool {
for _, item := range items {
if _, contains := set.tree.Get(item); !contains {
return false
}
}
return true
}
// Empty returns true if set does not contain any elements.
func (set *Set) Empty() bool {
return set.tree.Size() == 0
}
// Size returns number of elements within the set.
func (set *Set) Size() int {
return set.tree.Size()
}
// Clear clears all values in the set.
func (set *Set) Clear() {
set.tree.Clear()
}
// Values returns all items in the set.
func (set *Set) Values() []interface{} {
return set.tree.Keys()
}
// String returns a string representation of container
func (set *Set) String() string {
str := "TreeSet\n"
items := []string{}
for _, v := range set.tree.Keys() {
items = append(items, fmt.Sprintf("%v", v))
}
str += strings.Join(items, ", ")
return str
}