feat: add return value for Remove() method

[Bychin]

Add boolean return value for Remove() method.
Sometimes it is useful to know whether the element was actually removed on not. But I don't want to call Contains() before Remove() because it requires extra r-lock call.

[Bychin]

@rdleal may you please look at the PR?

[rdleal]

Hi @Bychin sorry for the delay. I will take a look at the PR today!

[rdleal]

@Bychin the change you are proposing is a breaking change to the current API. We can't change the signature of a function in Go and still keeps its backward compatibility, as users of this package might be relying on the Remove signature to, for example, define an interface on their side:

type PriorityQueueRemover interface {
	Remove(k string)
}

func main() {
	pq := kpq.NewKeyedPriorityQueue[string](cmp) // cmp function definition omitted for brevity.
	var x PriorityQueueRemover = pq
	fmt.Println(x)
}

A good practice here would be to add a new method with the new signature. For example, adding the method Delete(k K) (existed bool) or something like we have in the sync.Map type, PopKey(k K) (value V, exists bool), to remove a specific key, returning its value and a boolean indicating whether it indeed existed in the priority queue.

What do you think of it and which of those you think solves best your use case?

For more on backward compatibility in Go, please refer to the following articles:

• Backward Compatibility In Go
• Keeping Your Modules Compatible