Golang sort.SliceIsSorted Function

The sort.SliceIsSorted function in Golang is part of the sort package and is used to check if a slice is sorted according to a custom comparison function. This function is particularly useful when you need to verify that a slice is sorted based on specific criteria before performing operations that rely on sorted data, such as binary search or merging sorted slices.

Table of Contents

1. Introduction
2. sort.SliceIsSorted Function Syntax
3. Examples
   • Basic Usage
   • Checking if a Slice of Structs is Sorted
   • Checking Sorting with Multiple Conditions
4. Real-World Use Case Example
5. Conclusion

Introduction

The sort.SliceIsSorted function provides a way to verify whether a slice is sorted according to a custom comparison function. This function is highly flexible, allowing you to define your own criteria for sorting, and can be used with any data type. It’s particularly useful in scenarios where maintaining sorted data is crucial for performance or correctness.

sort.SliceIsSorted Function Syntax

The syntax for the sort.SliceIsSorted function is as follows:

func SliceIsSorted(slice interface{}, less func(i, j int) bool) bool

Parameters:

• slice: The slice you want to check. It can be a slice of any data type.
• less: A comparison function that takes two indices (i and j) and returns true if the element at index i should appear before the element at index j.

Returns:

• bool: A boolean value indicating whether the slice is sorted according to the comparison function (true if sorted, false otherwise).

Examples

Basic Usage

This example demonstrates how to use sort.SliceIsSorted to check if a slice of integers is sorted in descending order.

Example

package main

import (
	"fmt"
	"sort"
)

func main() {
	numbers := []int{6, 5, 4, 3, 2, 1}

	isSorted := sort.SliceIsSorted(numbers, func(i, j int) bool {
		return numbers[i] > numbers[j]
	})

	fmt.Println("Is the slice sorted in descending order?", isSorted)
}

Output:

Is the slice sorted in descending order? true

Explanation:

• The sort.SliceIsSorted function checks if the numbers slice is sorted in descending order by defining the comparison function to return true when the element at index i is greater than the element at index j.
• The function returns true since the slice is sorted in descending order.

Checking if a Slice of Structs is Sorted

This example shows how to use sort.SliceIsSorted to check if a slice of structs is sorted by a specific field, such as age.

Example

package main

import (
	"fmt"
	"sort"
)

type Person struct {
	Name string
	Age  int
}

func main() {
	people := []Person{
		{"Alice", 30},
		{"Bob", 25},
		{"Charlie", 35},
	}

	isSorted := sort.SliceIsSorted(people, func(i, j int) bool {
		return people[i].Age < people[j].Age
	})

	fmt.Println("Is the slice of people sorted by age?", isSorted)
}

Output:

Is the slice of people sorted by age? false

Explanation:

• The sort.SliceIsSorted function checks if the people slice is sorted by the Age field in ascending order.
• The function returns false because the slice is not sorted by age.

Checking Sorting with Multiple Conditions

This example demonstrates how to use sort.SliceIsSorted to check if a slice of structs is sorted using multiple fields, such as sorting by age and then by name if the ages are equal.

Example

package main

import (
	"fmt"
	"sort"
)

type Person struct {
	Name string
	Age  int
}

func main() {
	people := []Person{
		{"Charlie", 25},
		{"Alice", 30},
		{"Bob", 30},
		{"David", 25},
	}

	isSorted := sort.SliceIsSorted(people, func(i, j int) bool {
		if people[i].Age == people[j].Age {
			return people[i].Name < people[j].Name
		}
		return people[i].Age < people[j].Age
	})

	fmt.Println("Is the slice of people sorted by age and name?", isSorted)
}

Output:

Is the slice of people sorted by age and name? false

Explanation:

• The sort.SliceIsSorted function checks if the people slice is sorted first by the Age field and then by the Name field if the ages are equal.
• The function returns false because the slice is not sorted according to the specified criteria.

Real-World Use Case Example: Validating Sorted Product List

Suppose you have a list of products that you need to verify is sorted by price and then by name if the prices are the same.

Example: Checking Sorted Products

package main

import (
	"fmt"
	"sort"
)

type Product struct {
	Name  string
	Price float64
}

func main() {
	products := []Product{
		{"Product A", 19.99},
		{"Product B", 29.99},
		{"Product C", 19.99},
		{"Product D", 9.99},
	}

	isSorted := sort.SliceIsSorted(products, func(i, j int) bool {
		if products[i].Price == products[j].Price {
			return products[i].Name < products[j].Name
		}
		return products[i].Price < products[j].Price
	})

	fmt.Println("Is the product list sorted by price and name?", isSorted)
}

Output:

Is the product list sorted by price and name? false

Explanation:

• The sort.SliceIsSorted function checks if the products slice is sorted first by Price and then by Name if the prices are equal.
• The function returns false because the slice is not sorted according to the specified criteria.

Conclusion

The sort.SliceIsSorted function in Go is used for verifying whether a slice is sorted according to custom criteria. It allows you to define your own comparison logic, making it applicable to any data type and a wide range of sorting scenarios. Whether you’re working with simple data types or complex structs, sort.SliceIsSorted helps ensure that your data is in the correct order before performing operations that depend on sorted data.