Bag

type Interface ¶

type Interface interface {
	Add(item interface{}) Interface
	Remove(item interface{}) Interface
	Count(item interface{}) int
	Has(item interface{}) bool
	Len() int
	DistinctLen() int
	IsEmpty() bool
	Each(fn func(item interface{}, count int) Result.Interface) Result.Interface
	ToArray() Array.Interface
	DistinctArray() Array.Interface
	Sum(other Interface) Interface
	Union(other Interface) Interface
	Intersection(other Interface) Interface
	Difference(other Interface) Interface
	Equal(other Interface) bool
	IsNull() bool
}

Interface is the public contract of a Bag composite — a multiset (a "counted collection" / Counter): a collection of items each carrying a multiplicity. It rounds out the go-composites collection family next to Set (unique), OrderedSet (insertion-ordered) and SortedSet (sorted), sharing the Each/ToArray grammar of Array. Items are arbitrary comparable values (a Bag is backed by a Go map, so each item must be comparable, exactly like a Dictionary key). Membership tests return a plain bool, fallible iteration returns a Result, and every method honours the Null-Object invariant (never nil).

func New(items ...interface{}) Interface

func Null() Interface