https://github.com/ghosind/collection

Generics collections framework for Golang.
https://github.com/ghosind/collection

collections collections-framework generics-collections generics-in-golang golang golang-collections golang-library

Last synced: 9 days ago
JSON representation

Generics collections framework for Golang.

• Host: GitHub
• URL: https://github.com/ghosind/collection
• Owner: ghosind
• License: mit
• Created: 2022-07-20T09:27:23.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-07T14:39:52.000Z (5 months ago)
• Last Synced: 2024-06-07T16:12:48.277Z (5 months ago)
• Topics: collections, collections-framework, generics-collections, generics-in-golang, golang, golang-collections, golang-library
• Language: Go
• Homepage: https://pkg.go.dev/github.com/ghosind/collection
• Size: 88.9 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# collection

![Test](https://github.com/ghosind/collection/workflows/collection/badge.svg)

[![codecov](https://codecov.io/gh/ghosind/collection/branch/main/graph/badge.svg)](https://codecov.io/gh/ghosind/collection)

[![Latest version](https://img.shields.io/github/v/release/ghosind/collection?include_prereleases)](https://github.com/ghosind/collection)

![License Badge](https://img.shields.io/github/license/ghosind/collection)

[![Go Reference](https://pkg.go.dev/badge/github.com/ghosind/collection.svg)](https://pkg.go.dev/github.com/ghosind/collection)

Generics collections framework for Golang.

> IMPORTANT NOTICE: This package requires Go version 1.18+.

## Overview

This package provides the following data structure interfaces and implementations:

- `Collection`: The root interface of most of the structures in this package (without `Dictionary`).

- `Set`: A collection interface that contains no duplicate elements.

    - [`HashSet`](https://pkg.go.dev/github.com/ghosind/collection/set#HashSet): The implementation of Set based on Go built-in map structure.

    - [`ConcurrentHashSet`](https://pkg.go.dev/github.com/ghosind/collection/set#ConcurrentHashSet): The thread safe implementation of Set based on Go built-in map structure.

- `Dictionary`: A object that maps keys to values, and it cannot contain duplicate key.

    - [`HashDictionary`](https://pkg.go.dev/github.com/ghosind/collection/dict#ConcurrentHashDictionary): The implementation of Dictionary based on Go built-in map structure.

    - [`ConcurrencyHashDictionary`](https://pkg.go.dev/github.com/ghosind/collection/dict#ConcurrencyHashDictionary): The thread safe implementation of HashDictionary.

## Installation

You can install this package by the following command.

```sh

go get -u github.com/ghosind/collection

```

After installation, you can import it by the following code.

```go

import "github.com/ghosind/collection"

```

## Examples

### HashSet Examples

Create a string set, add and test elements in the set.

```go

// import "github.com/ghosind/collection/set"

fruits := set.NewHashSet[string]()

fruits.Add("Apple")

fruits.Add("Banana")

log.Print(fruits.Contains("Banana")) // true

log.Print(fruits.Contains("Lemon"))

```

### HashDictionary Examples

```go

// import "github.com/ghosind/collection/dict"

languages := dict.NewHashDictionary[string, int]()

languages.Put("C", 1972)

languages.Put("Go", 2007)

log.Print(languages.GetDefault("C", 0)) // 1972

```