Skip to content

Commit 226bd3d

Browse files
Sah, NandeshwarSah, Nandeshwar
authored andcommitted
updated README for new version v8.12.0
1 parent b1a7d96 commit 226bd3d

File tree

1 file changed

+43
-39
lines changed

1 file changed

+43
-39
lines changed

README.md

Lines changed: 43 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ go install github.com/logic-building/functional-go/gofp
2121
```
2222
[[constraint]]
2323
name = "github.com/logic-building/functional-go"
24-
version = "8.11.0"
24+
version = "8.12.0"
2525
```
2626

2727
### Quick Start
@@ -249,45 +249,49 @@ Options on go:generate :
249249
1. Dedupe<Type> : Returns a new list removing consecutive duplicates in provided list.
250250
2. Difference<Type> : Returns a set that is the first set without elements of the remaining sets
251251
3. Distinct<Type> : Returns a new list with duplicates removed.
252-
4. Drop<Type> : Returns a new list after dropping the given item
253-
5. DropWhile<Type> : Returns a new list after dropping the items in the given list as long as condition satisfies(1st argument - predicate)
254-
6. Even<Type>P : Returns true if n is even
255-
7. Every<Type> : Returns true if supplied predicate function(1st argument) returns logical true for every item in the list
256-
8. Exists<Type> : Returns true if given item exists in the list else false
257-
9. Filter<Type> : Returns a new list after filtering the list(2nd argument) based on predicate function passed (1st argument)
258-
10. FilterMap<Type> : Returns a new list after filtering given list(3rd argument), based on predicate function(1st argument) then apply function(2nd argument) on each item in the list(3rd argument)
259-
11. FilterMap<InputType><OutputType> : similar to FilterMap<Type> with additional feature - input(3rd argument) type is different
252+
4. Distinct<Type>P : Returns true if no two of the arguments are =
253+
5. Drop<Type> : Returns a new list after dropping the given item
254+
6. DropWhile<Type> : Returns a new list after dropping the items in the given list as long as condition satisfies(1st argument - predicate)
255+
7. Equal<Type>sP : Returns true if both list are equal else returns false
256+
8. EqualMap<Type>P : Returns true if both maps are equal else returns false
257+
9. EqualMap<Type1><Type2>P : Returns true if both maps are equal else returns false
258+
10. Even<Type>P : Returns true if n is even
259+
11. Every<Type> : Returns true if supplied predicate function(1st argument) returns logical true for every item in the list
260+
12. Exists<Type> : Returns true if given item exists in the list else false
261+
13. Filter<Type> : Returns a new list after filtering the list(2nd argument) based on predicate function passed (1st argument)
262+
14. FilterMap<Type> : Returns a new list after filtering given list(3rd argument), based on predicate function(1st argument) then apply function(2nd argument) on each item in the list(3rd argument)
263+
15. FilterMap<InputType><OutputType> : similar to FilterMap<Type> with additional feature - input(3rd argument) type is different
260264
output(return list) type is different
261-
12. Intersection<Type> : Returns a set that is the intersection of the input sets. Repeated value within the list(arguments) will be ignored
262-
13. Keys<Type> : Returns new a list of map's keys
263-
14. Map<Type> : Returns a new list after applying the function(1st argument) on each item in the list(2nd argument)
264-
15. Map<InputType><OutputType> : Similar to Map<Type> with additional feature - input(2nd argument) type is different and output(return) type is different
265-
16. Max<Type> : Returns max item from the list.
266-
17. Merge<Type> : Returns new map[<Type>]<Type> after merging map[<Type>]<Type> and map[<Type>]<Type>
267-
18. Merge<Type1><Type2>: Returns new map<[<Type1>]<Type2> after merging map[<Type1>]<Type2> and map[<Type1>]<Type2>
268-
19. Min<Type> : Returns min item from the list.
269-
20. MinMax<Type> : Returns min and max items from the list.
270-
21. Neg<Type>P : Returns true if num is less than zero, else false
271-
22. Odd<Type>P : Returns true if n is odd
272-
23. PMap<Type> : Similar to Map<Type> with additional feature - function(1st) argument runs concurrently for each item in the list(2nd argument)
273-
24. PMap<InputType><OutputType>: Similar to Map<InputType><OutputType> with additional feature - function(1st) argument runs concurrently for each item in the list(2nd argument)
274-
25. Pos<Type>P : Returns true if num is greater than zero, else false
275-
26. Range<Type> : Returns a new list of range between lower and upper value. Optional argument(3rd) will increment value by given number
276-
27. Reduce<Type> : Reduces a list to a single value by combining elements via a supplied function
277-
28. Remove<Type> : Returns a new list after removing the items from the given list(2nd argument) based on supplied predicate function(1st argument)
278-
29. Rest<Type> : Returns a new list after removing 1st item in the list(2nd argument)
279-
30. Reverse<Type> : Returns a new list after reversing the list
280-
31. Set<Type> : Returns a new list after removing duplicates items in the list
281-
32. Some<Type> : Returns true if item is found in the list(2nd argument) based on predicate function(1st argument)
282-
33. Sort<Type>s : Returns new sorted list
283-
34. Subset<Type> : Returns true or false by checking if set1 is a subset of set2. Repeated value within list(argument) will be ignored
284-
35. Superset<Type> : Returns true or false by checking if set1 is a superset of set2. Repeated value within list(argument) will be ignored
285-
36. Take<Type> : Returns n items in the list
286-
37. TakeWhile<Type> : Returns a new list based on predicate function(1st argument). It returns new list once condition fails.
287-
38. Union<Type> : Return a set that is the union of the input sets. Repeated value within list(argument) will be ignored
288-
39. Zero<Type>P : Returns true if num is zero, else false
289-
40. Zip<Type> : Returns New map([<Type>])Type after merging two lists
290-
41. Zip<Type1><Type2> : Similar to Zip<Type> with additional feature: Type of both list can be different
265+
16. Intersection<Type> : Returns a set that is the intersection of the input sets. Repeated value within the list(arguments) will be ignored
266+
17. Keys<Type> : Returns new a list of map's keys
267+
18. Map<Type> : Returns a new list after applying the function(1st argument) on each item in the list(2nd argument)
268+
19. Map<InputType><OutputType> : Similar to Map<Type> with additional feature - input(2nd argument) type is different and output(return) type is different
269+
20. Max<Type> : Returns max item from the list.
270+
21. Merge<Type> : Returns new map[<Type>]<Type> after merging map[<Type>]<Type> and map[<Type>]<Type>
271+
22. Merge<Type1><Type2>: Returns new map<[<Type1>]<Type2> after merging map[<Type1>]<Type2> and map[<Type1>]<Type2>
272+
23. Min<Type> : Returns min item from the list.
273+
24. MinMax<Type> : Returns min and max items from the list.
274+
25. Neg<Type>P : Returns true if num is less than zero, else false
275+
26. Odd<Type>P : Returns true if n is odd
276+
27. PMap<Type> : Similar to Map<Type> with additional feature - function(1st) argument runs concurrently for each item in the list(2nd argument)
277+
28. PMap<InputType><OutputType>: Similar to Map<InputType><OutputType> with additional feature - function(1st) argument runs concurrently for each item in the list(2nd argument)
278+
29. Pos<Type>P : Returns true if num is greater than zero, else false
279+
30. Range<Type> : Returns a new list of range between lower and upper value. Optional argument(3rd) will increment value by given number
280+
31. Reduce<Type> : Reduces a list to a single value by combining elements via a supplied function
281+
32. Remove<Type> : Returns a new list after removing the items from the given list(2nd argument) based on supplied predicate function(1st argument)
282+
33. Rest<Type> : Returns a new list after removing 1st item in the list(2nd argument)
283+
34. Reverse<Type> : Returns a new list after reversing the list
284+
35. Set<Type> : Returns a new list after removing duplicates items in the list
285+
36. Some<Type> : Returns true if item is found in the list(2nd argument) based on predicate function(1st argument)
286+
37. Sort<Type>s : Returns new sorted list
287+
38. Subset<Type> : Returns true or false by checking if set1 is a subset of set2. Repeated value within list(argument) will be ignored
288+
39. Superset<Type> : Returns true or false by checking if set1 is a superset of set2. Repeated value within list(argument) will be ignored
289+
40. Take<Type> : Returns n items in the list
290+
41. TakeWhile<Type> : Returns a new list based on predicate function(1st argument). It returns new list once condition fails.
291+
42. Union<Type> : Return a set that is the union of the input sets. Repeated value within list(argument) will be ignored
292+
43. Zero<Type>P : Returns true if num is zero, else false
293+
44. Zip<Type> : Returns New map([<Type>])Type after merging two lists
294+
45. Zip<Type1><Type2> : Similar to Zip<Type> with additional feature: Type of both list can be different
291295
```
292296

293297
### Contains functions

0 commit comments

Comments
 (0)