runeset

README

runeset

A simple set type for Unicode characters in Go (a.k.a. runes).

Documentation

Overview

Example

s1 := MakeFromString("1234567")
s2 := MakeFromString("86420")
fmt.Println(s1.Intersection(s2))

Output:

Set{2 4 6}

Example (InvertedIndex)

index := make(map[string]Set)
index["CHESS"] = Make('♚', '♛', '♜', '♝', '♞', '♟', '♔', '♕', '♖', '♗', '♘', '♙')
index["BLACK"] = Make('⚑', '■', '🖤', '★', '☎', '☻', '♚', '♛', '♜', '♝', '♞', '♟', '♠', '♣', '✂', '㉈')
index["REGISTERED"] = Make('®')
result := index["CHESS"].Intersection(index["BLACK"])
fmt.Println(result)

Output:

Set{♚ ♛ ♜ ♝ ♞ ♟}

Index

• type Set
  • func Make(chars ...rune) Set
  • func MakeFromString(text string) Set
  • func (s Set) Add(r rune)
  • func (s Set) Contains(r rune) bool
  • func (s Set) Copy() Set
  • func (s Set) Equal(other Set) bool
  • func (s Set) Intersection(other Set) Set
  • func (s Set) IntersectionUpdate(other Set)
  • func (s Set) Sorted() []rune
  • func (s Set) String() string

Examples

• Package
• Package (InvertedIndex)

Types

type Set

type Set map[rune]struct{}

Set represents a set of runes

func Make

func Make(chars ...rune) Set

Make creates and returns a new Set

func MakeFromString

func MakeFromString(text string) Set

MakeFromString creates and returns a new Set

func (Set) Add

func (s Set) Add(r rune)

Add a rune to the set.

func (Set) Contains

func (s Set) Contains(r rune) bool

Contains reports whether set contains given rune

func (Set) Copy

func (s Set) Copy() Set

Copy returns a new Set: a copy of s.

func (Set) Equal

func (s Set) Equal(other Set) bool

Equal reports whether set is equal to other

func (Set) Intersection

func (s Set) Intersection(other Set) Set

Intersection returns a new set: the intersection of s AND other

func (Set) IntersectionUpdate

func (s Set) IntersectionUpdate(other Set)

IntersectionUpdate changes receiver in-place, keeping only elements that are in it AND in other.

func (Set) Sorted

func (s Set) Sorted() []rune

Sorted returns sorted slice with runes from s

func (Set) String

func (s Set) String() string