Skip to content

Commit f5c3f8f

Browse files
Sah, NandeshwarSah, Nandeshwar
authored andcommitted
updated README for function docs
1 parent ddcdacf commit f5c3f8f

File tree

1 file changed

+42
-41
lines changed

1 file changed

+42
-41
lines changed

README.md

Lines changed: 42 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -237,47 +237,48 @@ Options on go:generate :
237237

238238
### All Standard FP Function
239239
```
240-
1. Dedupe<Type>
241-
2. Difference<Type>
242-
3. Distinct<Type>
243-
4. Drop<Type>
244-
5. DropWhile<Type>
245-
6. Even<Type>P
246-
7. Every<Type>
247-
8. Exists<Type>
248-
9. Filter<Type>
249-
10. FilterMap<Type>
250-
11. FilterMap<InputType><OutputType>
251-
12. Intersection<Type>
252-
13. Keys<Type>
253-
14. Map<Type>
254-
15. Map<InputType><OutputType>
255-
16. Max<Type>
256-
17. Merge<Type>
257-
18. Merge<Type1><Type2>
258-
19. Min<Type>
259-
20. MinMax<Type>
260-
21. Neg<Type>P
261-
22. Odd<Type>P
262-
23. PMap<Type>
263-
24. PMap<InputType><OutputType>
264-
25. Pos<Type>P
265-
26. Range<Type>
266-
27. Remove<Type>
267-
28. Reduce<Type>
268-
29. Rest<Type>
269-
30. Reverse<Type>
270-
31. Set<Type>
271-
32. Some<Type>
272-
33. Subset<Type>
273-
34. Superset<Type>
274-
35. Sort<Type>s
275-
36. Take<Type>
276-
37. TakeWhile<Type>
277-
38. Union<Type>
278-
39. Zero<Type>P
279-
40. Zip<Type>
280-
41. Zip<Type1><Type2>
240+
1. Dedupe<Type> : Returns a new list removing consecutive duplicates in provided list.
241+
2. Difference<Type> : Returns a set that is the first set without elements of the remaining sets
242+
3. Distinct<Type> : Returns a new list with duplicates removed.
243+
4. Drop<Type> : Returns a new list after dropping the given item
244+
5. DropWhile<Type> : Returns a new list after dropping the items in the given list as long as condition satisfies(1st argument - predicate)
245+
6. Even<Type>P : Returns true if n is even
246+
7. Every<Type> : Returns true if supplied predicate function(1st argument) returns logical true for every item in the list
247+
8. Exists<Type> : Returns true if given item exists in the list else false
248+
9. Filter<Type> : Returns a new list after filtering the list(2nd argument) based on predicate function passed (1st argument)
249+
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)
250+
11. FilterMap<InputType><OutputType> : similar to FilterMap<Type> with additional feature - input(3rd argument) type is different
251+
output(return list) type is different
252+
12. Intersection<Type> : Returns a set that is the intersection of the input sets. Repeated value within the list(arguments) will be ignored
253+
13. Keys<Type> : Returns new a list of map's keys
254+
14. Map<Type> : Returns a new list after applying the function(1st argument) on each item in the list(2nd argument)
255+
15. Map<InputType><OutputType> : Similar to Map<Type> with additional feature - input(2nd argument) type is different and output(return) type is different
256+
16. Max<Type> : Returns max item from the list.
257+
17. Merge<Type> : Returns new map[<Type>]<Type> after merging map[<Type>]<Type> and map[<Type>]<Type>
258+
18. Merge<Type1><Type2>: Returns new map<[<Type1>]<Type2> after merging map[<Type1>]<Type2> and map[<Type1>]<Type2>
259+
19. Min<Type> : Returns min item from the list.
260+
20. MinMax<Type> : Returns min and max items from the list.
261+
21. Neg<Type>P : Returns true if num is less than zero, else false
262+
22. Odd<Type>P : Returns true if n is odd
263+
23. PMap<Type> : Similar to Map<Type> with additional feature - function(1st) argument runs concurrently for each item in the list(2nd argument)
264+
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)
265+
25. Pos<Type>P : Returns true if num is greater than zero, else false
266+
26. Range<Type> : Returns a new list of range between lower and upper value. Optional argument(3rd) will increment value by given number
267+
27. Reduce<Type> : Reduces a list to a single value by combining elements via a supplied function
268+
28. Remove<Type> : Returns a new list after removing the items from the given list(2nd argument) based on supplied predicate function(1st argument)
269+
29. Rest<Type> : Returns a new list after removing 1st item in the list(2nd argument)
270+
30. Reverse<Type> : Returns a new list after reversing the list
271+
31. Set<Type> : Returns a new list after removing duplicates items in the list
272+
32. Some<Type> : Returns true if item is found in the list(2nd argument) based on predicate function(1st argument)
273+
33. Sort<Type>s : Returns new sorted list
274+
34. Subset<Type> : Returns true or false by checking if set1 is a subset of set2. Repeated value within list(argument) will be ignored
275+
35. Superset<Type> : Returns true or false by checking if set1 is a superset of set2. Repeated value within list(argument) will be ignored
276+
36. Take<Type> : Returns n items in the list
277+
37. TakeWhile<Type> : Returns a new list based on predicate function(1st argument). It returns new list once condition fails.
278+
38. Union<Type> : Return a set that is the union of the input sets. Repeated value within list(argument) will be ignored
279+
39. Zero<Type>P : Returns true if num is zero, else false
280+
40. Zip<Type> : Returns New map([<Type>])Type after merging two lists
281+
41. Zip<Type1><Type2> : Similar to Zip<Type> with additional feature: Type of both list can be different
281282
```
282283

283284
### Contains functions

0 commit comments

Comments
 (0)