random

README

Random

Package random is generics based random choice utility. Similar of Python's standard package.

Note: This was created to help me learn about generics.

Requirements

Go 1.18 or later

Usage

See example test code.

Test

go test .

You can use GitHub Actions locally by act.

act -j test

Documentation

Index

• Variables
• func Choice[T any](in []T) (T, error)
• func Choices[T any](in []T, size int) ([]T, error)
• func Sample[T any](in []T, size int) ([]T, error)

Examples

• Choice
• Choices
• Sample

Variables

var ErrEmptySlice = errors.New("slice is empty")

ErrEmptySlice slice is empty.

var ErrNegativeSize = errors.New("size is negative")

ErrNegativeSize size is negative.

var ErrSizeTooLarge = errors.New("size is greater than slice")

ErrSizeTooLarge size is greater than slice.

Functions

func Choice

func Choice[T any](in []T) (T, error)

Choice return a random element from slice. Similar of Python's random.choice(). see: https://docs.python.org/3/library/random.html#random.choice

Example

package main

import (
	"fmt"

	"github.com/sg0hsmt/random"
)

func main() {
	// Example for int slice.
	{
		in := []int{1, 2, 3, 4, 5, 6, 7, 8, 9}

		out, err := random.Choice(in)
		if err != nil {
			fmt.Println("choice failed")
			return
		}

		fmt.Println(out) // print one number.
	}

	// Example for string slice.
	{
		in := []string{"a", "b", "c", "d", "e", "f"}

		out, err := random.Choice(in)
		if err != nil {
			fmt.Println("choice failed")
			return
		}

		fmt.Println(out) // print one string.
	}
}

func Choices

func Choices[T any](in []T, size int) ([]T, error)

Choices returns multiple elements from slice. Similar of Python's random.choices(), But wight is not support. see: https://docs.python.org/3/library/random.html#random.choices

Example

package main

import (
	"fmt"

	"github.com/sg0hsmt/random"
)

func main() {
	// Example for int slice.
	{
		in := []int{1, 2, 3, 4, 5, 6, 7, 8, 9}

		out, err := random.Choices(in, 3)
		if err != nil {
			fmt.Println("choices failed")
			return
		}

		fmt.Println(out) // print three numbers.
	}

	// Example for string slice.
	{
		in := []string{"a", "b", "c", "d", "e", "f"}

		out, err := random.Choices(in, 3)
		if err != nil {
			fmt.Println("choices failed")
			return
		}

		fmt.Println(out) // print three strings.
	}
}

func Sample

func Sample[T any](in []T, size int) ([]T, error)

Sample returns unique elements from slice. Similar of Python's random.sample(). see: https://docs.python.org/3/library/random.html#random.sample

Example

package main

import (
	"fmt"

	"github.com/sg0hsmt/random"
)

func main() {
	// Example for int slice.
	{
		in := []int{1, 2, 3, 4, 5, 6, 7, 8, 9}

		out, err := random.Sample(in, 3)
		if err != nil {
			fmt.Println("sample failed")
			return
		}

		fmt.Println(out) // print three unique numbers.
	}

	// Example for string slice.
	{
		in := []string{"a", "b", "c", "d", "e", "f"}

		out, err := random.Sample(in, 3)
		if err != nil {
			fmt.Println("sample failed")
			return
		}

		fmt.Println(out) // print three unique strings.
	}
}