package utils

Import Path
	github.com/emirpasic/gods/utils (on go.dev)

Dependency Relation
	imports 4 packages, and imported by 4 packages

Involved Source Files

	      comparator.go
	      sort.go
	   d➜ utils.go
		Package utils provides common utility functions.

		Provided functionalities:
		- sorting
		- comparators
Package-Level Type Names (total 2, in which 1 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Comparator (func)
		Comparator will make type assertion (see IntComparator for example),
		which will panic if a or b are not of the asserted type.

		Should return a number:
		   negative , if a < b
		   zero     , if a == b
		   positive , if a > b

		As Inputs Of (at least 5, all are exported)
			func Sort(values []interface{}, comparator Comparator)
			func github.com/emirpasic/gods/containers.GetSortedValues(container containers.Container, comparator Comparator) []interface{}
			func github.com/emirpasic/gods/lists.List.Sort(comparator Comparator)
			func github.com/emirpasic/gods/lists/arraylist.(*List).Sort(comparator Comparator)
			func github.com/emirpasic/gods/trees/binaryheap.NewWith(comparator Comparator) *binaryheap.Heap

	/* one unexported ... *//* one unexported: */
	 type sortable (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			comparator Comparator
			values []interface{}
		Methods (total 3, all are exported)
			( T) Len() int
			( T) Less(i, j int) bool
			( T) Swap(i, j int)
		Implements (at least 2, in which 1 are exported)
			 T : sort.Interface
			/* at least one unexported ... *//* at least one unexported: */
			 T : github.com/aws/aws-sdk-go/aws/corehandlers.lener


Package-Level Functions (total 18, all are exported)

	 func ByteComparator(a, b interface{}) int
		ByteComparator provides a basic comparison on byte

	 func Float32Comparator(a, b interface{}) int
		Float32Comparator provides a basic comparison on float32

	 func Float64Comparator(a, b interface{}) int
		Float64Comparator provides a basic comparison on float64

	 func Int16Comparator(a, b interface{}) int
		Int16Comparator provides a basic comparison on int16

	 func Int32Comparator(a, b interface{}) int
		Int32Comparator provides a basic comparison on int32

	 func Int64Comparator(a, b interface{}) int
		Int64Comparator provides a basic comparison on int64

	 func Int8Comparator(a, b interface{}) int
		Int8Comparator provides a basic comparison on int8

	 func IntComparator(a, b interface{}) int
		IntComparator provides a basic comparison on int

	 func RuneComparator(a, b interface{}) int
		RuneComparator provides a basic comparison on rune

	 func Sort(values []interface{}, comparator Comparator)
		Sort sorts values (in-place) with respect to the given comparator.

		Uses Go's sort (hybrid of quicksort for large and then insertion sort for smaller slices).

	 func StringComparator(a, b interface{}) int
		StringComparator provides a fast comparison on strings

	 func TimeComparator(a, b interface{}) int
		TimeComparator provides a basic comparison on time.Time

	 func ToString(value interface{}) string
		ToString converts a value to string.

	 func UInt16Comparator(a, b interface{}) int
		UInt16Comparator provides a basic comparison on uint16

	 func UInt32Comparator(a, b interface{}) int
		UInt32Comparator provides a basic comparison on uint32

	 func UInt64Comparator(a, b interface{}) int
		UInt64Comparator provides a basic comparison on uint64

	 func UInt8Comparator(a, b interface{}) int
		UInt8Comparator provides a basic comparison on uint8

	 func UIntComparator(a, b interface{}) int
		UIntComparator provides a basic comparison on uint

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.