is.Not (#30)

feat(predicate): is.Not
chore(loop): comments

Author: m4gshm

break/kv/loop/loop.go

@@ -1,7 +1,7 @@
 package loop
 
-// Loop is a function that returns the next key, value or false if there are no more elements.
-type Loop[K, V any] func() (K, V, bool, error)
+// Loop is a function that returns the next key\value or ok==false if there are no more elements.
+type Loop[K, V any] func() (key K, value V, ok bool, error error)
 
 // Track applies the 'consumer' function to position/element pairs retrieved by the 'next' function until the consumer returns the c.Break to stop.
 func (next Loop[K, V]) Track(consumer func(K, V) error) error {

break/loop/api.go

@@ -200,7 +200,7 @@ func Append[T any, TS ~[]T](next func() (T, bool, error), out TS) (TS, error) {
 	return out, nil
 }
 
-// ReduceOK reduces the elements retrieved by the 'next' function into an one using the 'merge' function.
+// Reduce reduces the elements retrieved by the 'next' function into an one using the 'merge' function.
 // If the 'next' function returns ok=false at the first call, the zero value of 'T' type is returned.
 func Reduce[T any](next func() (T, bool, error), merge func(T, T) T) (T, error) {
 	result, _, err := ReduceOK(next, merge)

break/loop/loop.go

@@ -1,7 +1,7 @@
 package loop
 
-// Loop is a function that returns the next element, false if there are no more elements or error if something is wrong.
-type Loop[T any] func() (T, bool, error)
+// Loop is a function that returns the next element, ok==false if there are no more elements or an error if something is wrong.
+type Loop[T any] func() (element T, ok bool, err error)
 
 // All is used to iterate through the loop using `for ... range`. Supported since go 1.22 with GOEXPERIMENT=rangefunc enabled.
 func (next Loop[T]) All(consumer func(T, error) bool) {

kv/loop/loop.go

@@ -8,8 +8,8 @@ import (
 	kvPredicate "github.com/m4gshm/gollections/kv/predicate"
 )
 
-// Loop is a function that returns the next key, value or false if there are no more elements.
-type Loop[K, V any] func() (K, V, bool)
+// Loop is a function that returns the next key\value or ok==false if there are no more elements.
+type Loop[K, V any] func() (key K, value V, ok bool)
 
 // All is used to iterate through the loop using `for ... range`. Supported since go 1.22 with GOEXPERIMENT=rangefunc enabled.
 func (next Loop[K, V]) All(consumer func(key K, value V) bool) {

loop/loop.go

@@ -5,8 +5,8 @@ import (
 	"github.com/m4gshm/gollections/c"
 )
 
-// Loop is a function that returns the next element or false if there are no more elements.
-type Loop[T any] func() (T, bool)
+// Loop is a function that returns the next element or ok=false if there are no more elements.
+type Loop[T any] func() (element T, ok bool)
 
 var (
 	_ c.Filterable[any, Loop[any], loop.Loop[any]]  = (Loop[any])(nil)

predicate/api.go

@@ -22,7 +22,7 @@ func Eq[T comparable](v T) Predicate[T] {
 	return func(c T) bool { return v == c }
 }
 
-// Not negates the 'p' predicate
+// Not creates a 'not p' predicate
 func Not[T any](p Predicate[T]) Predicate[T] {
 	return func(v T) bool { return !p(v) }
 }

predicate/is/api.go

@@ -0,0 +1,10 @@
+package is
+
+import (
+	"github.com/m4gshm/gollections/predicate"
+)
+
+// Not - is.Not creates a 'not p' predicate.
+func Not[T any](p predicate.Predicate[T]) predicate.Predicate[T] {
+	return predicate.Not(p)
+}

predicate/not/api.go

@@ -4,14 +4,15 @@ package not
 import (
 	"github.com/m4gshm/gollections/predicate"
 	"github.com/m4gshm/gollections/predicate/eq"
+	"github.com/m4gshm/gollections/predicate/is"
 )
 
-// Eq - not.Eq makes reverse of the eq.To predicate
+// Eq - not.Eq makes a 'not eq.To' predicate
 func Eq[T comparable](v T) predicate.Predicate[T] {
-	return predicate.Not(eq.To(v))
+	return is.Not(eq.To(v))
 }
 
-// Match - not.Match alias of predicate.Not
+// Match - not.Match makes a 'not predicate.Match' predicate
 func Match[From, To any](getter func(From) To, condition predicate.Predicate[To]) predicate.Predicate[From] {
-	return predicate.Not(predicate.Match(getter, condition))
+	return is.Not(predicate.Match(getter, condition))
 }