Skip to content

Commit

Permalink
🐛 docs: minimums, maximums, rearrange code
Browse files Browse the repository at this point in the history
  • Loading branch information
@wolfram77
wolfram77 committed May 8, 2023
1 parent 97abbea commit f69629a
Show file tree
Hide file tree
Showing 6 changed files with 1,633 additions and 1,583 deletions.
170 changes: 83 additions & 87 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,6 @@ xarray.permutations([1, 2, 3]);
| [flat] | Flatten nested array to given depth. |
| [flatMap] | Flatten nested array, based on map function. |
| | |
| [accumulate] | Produce accumulating values. |
| [exclusiveScan] | Perform exclusive prefix scan from left to right. |
| [exclusiveScan$] | Perform exclusive prefix scan from left to right! |
| [inclusiveScan] | Perform inclusive prefix scan from left to right. |
Expand Down Expand Up @@ -311,21 +310,26 @@ xarray.permutations([1, 2, 3]);
[![Test Coverage](https://api.codeclimate.com/v1/badges/77adb3752d187f463f25/test_coverage)](https://codeclimate.com/github/nodef/extra-array/test_coverage)


[fromRange]: https://github.com/nodef/extra-array/wiki/fromRange
[fromInvocation]: https://github.com/nodef/extra-array/wiki/fromInvocation
[fromApplication]: https://github.com/nodef/extra-array/wiki/fromApplication
[fromIterable]: https://github.com/nodef/extra-array/wiki/fromIterable
[fromIterable$]: https://github.com/nodef/extra-array/wiki/fromIterable$
[shallowClone]: https://github.com/nodef/extra-array/wiki/shallowClone
[deepClone]: https://github.com/nodef/extra-array/wiki/deepClone
[is]: https://github.com/nodef/extra-array/wiki/is
[keys]: https://github.com/nodef/extra-array/wiki/keys
[values]: https://github.com/nodef/extra-array/wiki/values
[entries]: https://github.com/nodef/extra-array/wiki/entries
[fromIterable]: https://github.com/nodef/extra-array/wiki/fromIterable
[fromIterable$]: https://github.com/nodef/extra-array/wiki/fromIterable$
[fromRange]: https://github.com/nodef/extra-array/wiki/fromRange
[fromInvocation]: https://github.com/nodef/extra-array/wiki/fromInvocation
[fromApplication]: https://github.com/nodef/extra-array/wiki/fromApplication
[compare]: https://github.com/nodef/extra-array/wiki/compare
[isEqual]: https://github.com/nodef/extra-array/wiki/isEqual
[ikeys]: https://github.com/nodef/extra-array/wiki/ikeys
[ivalues]: https://github.com/nodef/extra-array/wiki/ivalues
[ientries]: https://github.com/nodef/extra-array/wiki/ientries
[index]: https://github.com/nodef/extra-array/wiki/index
[indexRange]: https://github.com/nodef/extra-array/wiki/indexRange
[length]: https://github.com/nodef/extra-array/wiki/length
[isEmpty]: https://github.com/nodef/extra-array/wiki/isEmpty
[length]: https://github.com/nodef/extra-array/wiki/length
[resize$]: https://github.com/nodef/extra-array/wiki/resize$
[clear$]: https://github.com/nodef/extra-array/wiki/clear$
[get]: https://github.com/nodef/extra-array/wiki/get
[getAll]: https://github.com/nodef/extra-array/wiki/getAll
[getPath]: https://github.com/nodef/extra-array/wiki/getPath
Expand All @@ -335,69 +339,93 @@ xarray.permutations([1, 2, 3]);
[setPath$]: https://github.com/nodef/extra-array/wiki/setPath$
[swap]: https://github.com/nodef/extra-array/wiki/swap
[swap$]: https://github.com/nodef/extra-array/wiki/swap$
[swapRanges]: https://github.com/nodef/extra-array/wiki/swapRanges
[swapRanges$]: https://github.com/nodef/extra-array/wiki/swapRanges$
[remove]: https://github.com/nodef/extra-array/wiki/remove
[remove$]: https://github.com/nodef/extra-array/wiki/remove$
[removePath$]: https://github.com/nodef/extra-array/wiki/removePath$
[count]: https://github.com/nodef/extra-array/wiki/count
[countEach]: https://github.com/nodef/extra-array/wiki/countEach
[isSorted]: https://github.com/nodef/extra-array/wiki/isSorted
[hasUnsortedValue]: https://github.com/nodef/extra-array/wiki/hasUnsortedValue
[searchUnsortedValue]: https://github.com/nodef/extra-array/wiki/searchUnsortedValue
[sort]: https://github.com/nodef/extra-array/wiki/sort
[sort$]: https://github.com/nodef/extra-array/wiki/sort$
[partialSort]: https://github.com/nodef/extra-array/wiki/partialSort
[partialSort$]: https://github.com/nodef/extra-array/wiki/partialSort$
[minimum]: https://github.com/nodef/extra-array/wiki/minimum
[minimumEntry]: https://github.com/nodef/extra-array/wiki/minimumEntry
[maximum]: https://github.com/nodef/extra-array/wiki/maximum
[maximumEntry]: https://github.com/nodef/extra-array/wiki/maximumEntry
[range]: https://github.com/nodef/extra-array/wiki/range
[rangeEntries]: https://github.com/nodef/extra-array/wiki/rangeEntries
[slice]: https://github.com/nodef/extra-array/wiki/slice
[slice$]: https://github.com/nodef/extra-array/wiki/slice$
[minimums]: https://github.com/nodef/extra-array/wiki/minimums
[minimumEntries]: https://github.com/nodef/extra-array/wiki/minimumEntries
[maximums]: https://github.com/nodef/extra-array/wiki/maximums
[maximumEntries]: https://github.com/nodef/extra-array/wiki/maximumEntries
[searchMinimumValue]: https://github.com/nodef/extra-array/wiki/searchMinimumValue
[searchMaximumValue]: https://github.com/nodef/extra-array/wiki/searchMaximumValue
[searchMinimumValues]: https://github.com/nodef/extra-array/wiki/searchMinimumValues
[searchMaximumValues]: https://github.com/nodef/extra-array/wiki/searchMaximumValues
[isEqual]: https://github.com/nodef/extra-array/wiki/isEqual
[compare]: https://github.com/nodef/extra-array/wiki/compare
[head]: https://github.com/nodef/extra-array/wiki/head
[last]: https://github.com/nodef/extra-array/wiki/last
[tail]: https://github.com/nodef/extra-array/wiki/tail
[init]: https://github.com/nodef/extra-array/wiki/init
[last]: https://github.com/nodef/extra-array/wiki/last
[middle]: https://github.com/nodef/extra-array/wiki/middle
[take]: https://github.com/nodef/extra-array/wiki/take
[takeRight]: https://github.com/nodef/extra-array/wiki/takeRight
[takeWhile]: https://github.com/nodef/extra-array/wiki/takeWhile
[takeWhileRight]: https://github.com/nodef/extra-array/wiki/takeWhileRight
[drop]: https://github.com/nodef/extra-array/wiki/drop
[dropRight]: https://github.com/nodef/extra-array/wiki/dropRight
[dropWhile]: https://github.com/nodef/extra-array/wiki/dropWhile
[dropWhileRight]: https://github.com/nodef/extra-array/wiki/dropWhileRight
[slice]: https://github.com/nodef/extra-array/wiki/slice
[slice$]: https://github.com/nodef/extra-array/wiki/slice$
[includes]: https://github.com/nodef/extra-array/wiki/includes
[hasValue]: https://github.com/nodef/extra-array/wiki/hasValue
[searchValue]: https://github.com/nodef/extra-array/wiki/searchValue
[searchValueRight]: https://github.com/nodef/extra-array/wiki/searchValueRight
[searchValueAll]: https://github.com/nodef/extra-array/wiki/searchValueAll
[searchAdjacentDuplicateValue]: https://github.com/nodef/extra-array/wiki/searchAdjacentDuplicateValue
[searchMismatchedValue]: https://github.com/nodef/extra-array/wiki/searchMismatchedValue
[hasPrefix]: https://github.com/nodef/extra-array/wiki/hasPrefix
[hasSuffix]: https://github.com/nodef/extra-array/wiki/hasSuffix
[hasInfix]: https://github.com/nodef/extra-array/wiki/hasInfix
[hasSubsequence]: https://github.com/nodef/extra-array/wiki/hasSubsequence
[hasPermutation]: https://github.com/nodef/extra-array/wiki/hasPermutation
[prefixes]: https://github.com/nodef/extra-array/wiki/prefixes
[suffixes]: https://github.com/nodef/extra-array/wiki/suffixes
[infixes]: https://github.com/nodef/extra-array/wiki/infixes
[subsequences]: https://github.com/nodef/extra-array/wiki/subsequences
[permutations]: https://github.com/nodef/extra-array/wiki/permutations
[iprefixes]: https://github.com/nodef/extra-array/wiki/iprefixes
[isuffixes]: https://github.com/nodef/extra-array/wiki/isuffixes
[iinfixes]: https://github.com/nodef/extra-array/wiki/iinfixes
[isubsequences]: https://github.com/nodef/extra-array/wiki/isubsequences
[ipermutations]: https://github.com/nodef/extra-array/wiki/ipermutations
[searchInfix]: https://github.com/nodef/extra-array/wiki/searchInfix
[searchInfixRight]: https://github.com/nodef/extra-array/wiki/searchInfixRight
[searchInfixAll]: https://github.com/nodef/extra-array/wiki/searchInfixAll
[searchSubsequence]: https://github.com/nodef/extra-array/wiki/searchSubsequence
[randomValue]: https://github.com/nodef/extra-array/wiki/randomValue
[randomPrefix]: https://github.com/nodef/extra-array/wiki/randomPrefix
[randomSuffix]: https://github.com/nodef/extra-array/wiki/randomSuffix
[randomInfix]: https://github.com/nodef/extra-array/wiki/randomInfix
[randomSubsequence]: https://github.com/nodef/extra-array/wiki/randomSubsequence
[randomPermutation]: https://github.com/nodef/extra-array/wiki/randomPermutation
[randomPermutation$]: https://github.com/nodef/extra-array/wiki/randomPermutation$
[includes]: https://github.com/nodef/extra-array/wiki/includes
[indexOf]: https://github.com/nodef/extra-array/wiki/indexOf
[lastIndexOf]: https://github.com/nodef/extra-array/wiki/lastIndexOf
[find]: https://github.com/nodef/extra-array/wiki/find
[findRight]: https://github.com/nodef/extra-array/wiki/findRight
[take]: https://github.com/nodef/extra-array/wiki/take
[takeRight]: https://github.com/nodef/extra-array/wiki/takeRight
[takeWhile]: https://github.com/nodef/extra-array/wiki/takeWhile
[takeWhileRight]: https://github.com/nodef/extra-array/wiki/takeWhileRight
[drop]: https://github.com/nodef/extra-array/wiki/drop
[dropRight]: https://github.com/nodef/extra-array/wiki/dropRight
[dropWhile]: https://github.com/nodef/extra-array/wiki/dropWhile
[dropWhileRight]: https://github.com/nodef/extra-array/wiki/dropWhileRight
[scanWhile]: https://github.com/nodef/extra-array/wiki/scanWhile
[scanWhileRight]: https://github.com/nodef/extra-array/wiki/scanWhileRight
[scanUntil]: https://github.com/nodef/extra-array/wiki/scanUntil
[scanUntilRight]: https://github.com/nodef/extra-array/wiki/scanUntilRight
[indexOf]: https://github.com/nodef/extra-array/wiki/indexOf
[lastIndexOf]: https://github.com/nodef/extra-array/wiki/lastIndexOf
[search]: https://github.com/nodef/extra-array/wiki/search
[searchRight]: https://github.com/nodef/extra-array/wiki/searchRight
[searchAll]: https://github.com/nodef/extra-array/wiki/searchAll
[searchValue]: https://github.com/nodef/extra-array/wiki/searchValue
[searchValueRight]: https://github.com/nodef/extra-array/wiki/searchValueRight
[searchValueAll]: https://github.com/nodef/extra-array/wiki/searchValueAll
[searchInfix]: https://github.com/nodef/extra-array/wiki/searchInfix
[searchInfixRight]: https://github.com/nodef/extra-array/wiki/searchInfixRight
[searchInfixAll]: https://github.com/nodef/extra-array/wiki/searchInfixAll
[searchSubsequence]: https://github.com/nodef/extra-array/wiki/searchSubsequence
[hasValue]: https://github.com/nodef/extra-array/wiki/hasValue
[hasPrefix]: https://github.com/nodef/extra-array/wiki/hasPrefix
[hasSuffix]: https://github.com/nodef/extra-array/wiki/hasSuffix
[hasInfix]: https://github.com/nodef/extra-array/wiki/hasInfix
[hasSubsequence]: https://github.com/nodef/extra-array/wiki/hasSubsequence
[hasPermutation]: https://github.com/nodef/extra-array/wiki/hasPermutation
[forEach]: https://github.com/nodef/extra-array/wiki/forEach
[some]: https://github.com/nodef/extra-array/wiki/some
[every]: https://github.com/nodef/extra-array/wiki/every
Expand All @@ -411,14 +439,21 @@ xarray.permutations([1, 2, 3]);
[reject]: https://github.com/nodef/extra-array/wiki/reject
[reject$]: https://github.com/nodef/extra-array/wiki/reject$
[rejectAt]: https://github.com/nodef/extra-array/wiki/rejectAt
[accumulate]: https://github.com/nodef/extra-array/wiki/accumulate
[flat]: https://github.com/nodef/extra-array/wiki/flat
[flatMap]: https://github.com/nodef/extra-array/wiki/flatMap
[exclusiveScan]: https://github.com/nodef/extra-array/wiki/exclusiveScan
[exclusiveScan$]: https://github.com/nodef/extra-array/wiki/exclusiveScan$
[inclusiveScan]: https://github.com/nodef/extra-array/wiki/inclusiveScan
[inclusiveScan$]: https://github.com/nodef/extra-array/wiki/inclusiveScan$
[adjacentCombine]: https://github.com/nodef/extra-array/wiki/adjacentCombine
[adjacentCombine$]: https://github.com/nodef/extra-array/wiki/adjacentCombine$
[intersperse]: https://github.com/nodef/extra-array/wiki/intersperse
[interpolate]: https://github.com/nodef/extra-array/wiki/interpolate
[intermix]: https://github.com/nodef/extra-array/wiki/intermix
[interleave]: https://github.com/nodef/extra-array/wiki/interleave
[zip]: https://github.com/nodef/extra-array/wiki/zip
[fill]: https://github.com/nodef/extra-array/wiki/fill
[fill$]: https://github.com/nodef/extra-array/wiki/fill$
[sort]: https://github.com/nodef/extra-array/wiki/sort
[sort$]: https://github.com/nodef/extra-array/wiki/sort$
[push]: https://github.com/nodef/extra-array/wiki/push
[push$]: https://github.com/nodef/extra-array/wiki/push$
[pop]: https://github.com/nodef/extra-array/wiki/pop
Expand All @@ -435,29 +470,27 @@ xarray.permutations([1, 2, 3]);
[moveWithin$]: https://github.com/nodef/extra-array/wiki/moveWithin$
[splice]: https://github.com/nodef/extra-array/wiki/splice
[splice$]: https://github.com/nodef/extra-array/wiki/splice$
[count]: https://github.com/nodef/extra-array/wiki/count
[countEach]: https://github.com/nodef/extra-array/wiki/countEach
[partition]: https://github.com/nodef/extra-array/wiki/partition
[partitionEach]: https://github.com/nodef/extra-array/wiki/partitionEach
[split]: https://github.com/nodef/extra-array/wiki/split
[splitAt]: https://github.com/nodef/extra-array/wiki/splitAt
[cut]: https://github.com/nodef/extra-array/wiki/cut
[cutRight]: https://github.com/nodef/extra-array/wiki/cutRight
[cutAt]: https://github.com/nodef/extra-array/wiki/cutAt
[cutAtRight]: https://github.com/nodef/extra-array/wiki/cutAtRight
[group]: https://github.com/nodef/extra-array/wiki/group
[partition]: https://github.com/nodef/extra-array/wiki/partition
[partitionEach]: https://github.com/nodef/extra-array/wiki/partitionEach
[chunk]: https://github.com/nodef/extra-array/wiki/chunk
[concat]: https://github.com/nodef/extra-array/wiki/concat
[concat$]: https://github.com/nodef/extra-array/wiki/concat$
[join]: https://github.com/nodef/extra-array/wiki/join
[cycle]: https://github.com/nodef/extra-array/wiki/cycle
[repeat]: https://github.com/nodef/extra-array/wiki/repeat
[reverse]: https://github.com/nodef/extra-array/wiki/reverse
[reverse$]: https://github.com/nodef/extra-array/wiki/reverse$
[rotate]: https://github.com/nodef/extra-array/wiki/rotate
[rotate$]: https://github.com/nodef/extra-array/wiki/rotate$
[intersperse]: https://github.com/nodef/extra-array/wiki/intersperse
[interpolate]: https://github.com/nodef/extra-array/wiki/interpolate
[intermix]: https://github.com/nodef/extra-array/wiki/intermix
[interleave]: https://github.com/nodef/extra-array/wiki/interleave
[concat]: https://github.com/nodef/extra-array/wiki/concat
[concat$]: https://github.com/nodef/extra-array/wiki/concat$
[join]: https://github.com/nodef/extra-array/wiki/join
[isUnique]: https://github.com/nodef/extra-array/wiki/isUnique
[isDisjoint]: https://github.com/nodef/extra-array/wiki/isDisjoint
[unique]: https://github.com/nodef/extra-array/wiki/unique
Expand All @@ -467,40 +500,3 @@ xarray.permutations([1, 2, 3]);
[difference]: https://github.com/nodef/extra-array/wiki/difference
[symmetricDifference]: https://github.com/nodef/extra-array/wiki/symmetricDifference
[cartesianProduct]: https://github.com/nodef/extra-array/wiki/cartesianProduct
[shallowClone]: https://github.com/nodef/extra-array/wiki/shallowClone
[deepClone]: https://github.com/nodef/extra-array/wiki/deepClone
[isSorted]: https://github.com/nodef/extra-array/wiki/isSorted
[ikeys]: https://github.com/nodef/extra-array/wiki/ikeys
[values$]: https://github.com/nodef/extra-array/wiki/values$
[ivalues]: https://github.com/nodef/extra-array/wiki/ivalues
[ientries]: https://github.com/nodef/extra-array/wiki/ientries
[resize$]: https://github.com/nodef/extra-array/wiki/resize$
[clear$]: https://github.com/nodef/extra-array/wiki/clear$
[countEach]: https://github.com/nodef/extra-array/wiki/countEach
[iprefixes]: https://github.com/nodef/extra-array/wiki/iprefixes
[isuffixes]: https://github.com/nodef/extra-array/wiki/isuffixes
[iinfixes]: https://github.com/nodef/extra-array/wiki/iinfixes
[isubsequences]: https://github.com/nodef/extra-array/wiki/isubsequences
[ipermutations]: https://github.com/nodef/extra-array/wiki/ipermutations
[searchUnsortedValue]: https://github.com/nodef/extra-array/wiki/searchUnsortedValue
[hasUnsortedValue]: https://github.com/nodef/extra-array/wiki/hasUnsortedValue
[swapRanges]: https://github.com/nodef/extra-array/wiki/swapRanges
[swapRanges$]: https://github.com/nodef/extra-array/wiki/swapRanges$
[searchAdjacentDuplicateValue]: https://github.com/nodef/extra-array/wiki/searchAdjacentDuplicateValue
[searchMismatchedValue]: https://github.com/nodef/extra-array/wiki/searchMismatchedValue
[exclusiveScan]: https://github.com/nodef/extra-array/wiki/exclusiveScan
[exclusiveScan$]: https://github.com/nodef/extra-array/wiki/exclusiveScan$
[inclusiveScan]: https://github.com/nodef/extra-array/wiki/inclusiveScan
[inclusiveScan$]: https://github.com/nodef/extra-array/wiki/inclusiveScan$
[adjacentCombine]: https://github.com/nodef/extra-array/wiki/adjacentCombine
[searchMinimumValue]: https://github.com/nodef/extra-array/wiki/searchMinimumValue
[searchMaximumValue]: https://github.com/nodef/extra-array/wiki/searchMaximumValue
[adjacentCombine$]: https://github.com/nodef/extra-array/wiki/adjacentCombine$
[partialSort]: https://github.com/nodef/extra-array/wiki/partialSort
[partialSort$]: https://github.com/nodef/extra-array/wiki/partialSort$
[minimums]: https://github.com/nodef/extra-array/wiki/minimums
[minimumEntries]: https://github.com/nodef/extra-array/wiki/minimumEntries
[maximums]: https://github.com/nodef/extra-array/wiki/maximums
[maximumEntries]: https://github.com/nodef/extra-array/wiki/maximumEntries
[searchMinimumValues]: https://github.com/nodef/extra-array/wiki/searchMinimumValues
[searchMaximumValues]: https://github.com/nodef/extra-array/wiki/searchMaximumValues
4 changes: 2 additions & 2 deletions package-lock.json
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "extra-array",
"version": "4.0.2",
"version": "4.0.3",
"description": "An array is a collection of values, stored contiguously.",
"main": "index.js",
"module": "index.mjs",
Expand Down
Loading

0 comments on commit f69629a

Please sign in to comment.