set

README

set

set is a data structure package written by Go. It provides some basic set functionalities of the user. It uses map data structure under the hood. It does not have any dependency.

Installation

go get github.com/gozeloglu/set

Example

package main

import (
    "fmt"
    "github.com/gozeloglu/set"
)

func main() {
	s := set.New()
	s.Add(123)

	exist := s.Contains(123)
	if !exist {
		fmt.Println("123 not exist")
	}

	s.Append(1, 2, 3, 4, "abc")    // Add multiple values
	values := []interface{}{"github", 100, 640, 0.43, false}
	s.Append(values...) // Append the array of elements 

	s.Remove(4)
	size := s.Size()
	fmt.Println(size)   // Prints 5

	s.Pop()    // Returns random value from the set
	s.Clear()
	fmt.Println(s.Size())   // Prints 0
	
	if s.Empty() {
            fmt.Println("set is empty")
        }   
}

Supported methods:

• Add(val interface{})
• Append(val ...interface{})
• Remove(val interface{})
• Contains(val interface{})
• Size()
• Pop()
• Clear()
• Empty()
• Slice()
• Union()
• Intersection()

Tests

You can run the tests with the following command.

go test ./...

You can check the code coverage with the following commands:

go test -coverprofile=coverage.out
go tool cover -html=coverage.out -o coverage.html

LICENSE

MIT

Documentation

Overview

Package set is a set package provides set data structure for Go. It is written without any dependency.

package main

import (
	"fmt"
	"github.com/gozeloglu/set"
)

func main() {
	s := set.New()
	s.Add(123)

	exist := s.Contains(123)
	if !exist {
		fmt.Println("123 not exist")
	}

	s.Append(1, 2, 3, 4, "abc")    // Add multiple values
	values := []interface{}{"github", 100, 640, 0.43, false}
	s.Append(values...) // Append the array of elements

	s.Remove(4)
	size := s.Size()
	fmt.Println(size)   // Prints 5

	s.Pop()    // Returns random value from the set
	s.Clear()
	fmt.Println(s.Size())   // Prints 0
}

You can call the Union() method for creating a new Set which contains the all items from the set1 and set2. It concatenates two sets and creates a new one.

union := set1.Union(set2)

In order to take intersection of the sets, you can call the Intersection() method.

intersect := set1.Intersection(set2)

Index

• type S
• type Set
  • func New() *Set
  • func (s *Set) Add(val interface{})
  • func (s *Set) Append(values ...interface{})
  • func (s *Set) Clear()
  • func (s Set) Contains(val interface{}) bool
  • func (s Set) Empty() bool
  • func (s *Set) Intersection(set *Set) *Set
  • func (s Set) Pop() interface{}
  • func (s *Set) Remove(val interface{})
  • func (s Set) Size() uint
  • func (s Set) Slice() []interface{}
  • func (s Set) Union(set *Set) *Set

Types

type S

type S interface {
	Add(val interface{})
	Append(val ...interface{})
	Remove(val interface{})
	Contains(val interface{}) bool
	Size() uint
	Pop() interface{}
	Clear()
	Empty() bool
	Slice() []interface{}
	Union(set *Set) *Set
	Intersection(set *Set) *Set
}

S is set interface.

type Set

type Set struct {
	// contains filtered or unexported fields
}

Set is the data structure which provides some functionalities.

func New

func New() *Set

New creates a set data structure.

func (*Set) Add

func (s *Set) Add(val interface{})

Add adds a new values to set if there is enough capacity.

func (*Set) Append

func (s *Set) Append(values ...interface{})

Append adds multiple values into set.

func (*Set) Clear

func (s *Set) Clear()

Clear removes everything from the set.

func (Set) Contains

func (s Set) Contains(val interface{}) bool

Contains checks the value whether exists in the set.

func (Set) Empty

func (s Set) Empty() bool

Empty checks whether the set is empty.

func (*Set) Intersection

func (s *Set) Intersection(set *Set) *Set

Intersection takes the common values from both sets and returns a new set that stores the common ones.

func (Set) Pop

func (s Set) Pop() interface{}

Pop returns a random value from the set. If there is no element in set, it returns nil.

func (*Set) Remove

func (s *Set) Remove(val interface{})

Remove deletes the given value.

func (Set) Size

func (s Set) Size() uint

Size returns the length of the set which means that number of value of the set.

func (Set) Slice

func (s Set) Slice() []interface{}

Slice returns the elements of the set as a slice. The slice type is interface{}. The elements can be in any order.

func (Set) Union

func (s Set) Union(set *Set) *Set

Union returns a new Set that contains all items from the receiver Set and all items from the given Set.