Add README for the compute module. #1940
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: remzi 13716567376yh@gmail.com
Which issue does this PR close?
Closes #1533 .
Rationale for this change
Improve the readability of the code.
What changes are included in this PR?
The README is mostly copied from the c++ repo: https://github.com/apache/arrow/blob/master/cpp/src/arrow/compute/README.md
Something different is that the term
function
andkernel
in c++ repo are not the same as that in rust repo. (I guess we don't implement those two structs in rust.)I defined
kernel
as a general operation (such ascompare
,sort
,take
...) which contains manyfunctions
.Are there any user-facing changes?
NO, I guess.