Skip to content

Add pairwise #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 15, 2021
Merged

Add pairwise #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions src/StatsAPI.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
module StatsAPI

# pairwise(f, x[, y])
#
# Return a matrix holding the result of applying `f` to all possible pairs
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are we sure it will always be a matrix? Maybe it should be a more general n-dimensional pairwise (but admittedly then it should probably be tuple-wise)

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In particular as x and y are allowed to be any iterators what should happen with a 0-dimensional iterator (e.g. when x is a number)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are we sure it will always be a matrix? Maybe it should be a more general n-dimensional pairwise (but admittedly then it should probably be tuple-wise)

"pairwise" seems to imply there are only two elements, right? IIRC we mentioned the possibility of having a more general outer function, but I find pairwise nicer to compute pairwise correlations, and it's already used by Distances.

In particular as x and y are allowed to be any iterators what should happen with a 0-dimensional iterator (e.g. when x is a number)

Well the number of dimensions of the iterator doesn't matter, only the number of elements it contains. So a number gives a 1×1 matrix.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK

# of entries in iterators `x` and `y`, and return it.
#
# This generic function is owned by StatsBase.jl, which is the sole provider
# of the default definition.
function pairwise end

# pairwise!(f, dest::AbstractMatrix, x[, y])
#
# Store in matrix `dest` the result of applying `f` to all possible pairs
# of entries in iterators `x` and `y`, and return it.
#
# This generic function is owned by StatsBase.jl, which is the sole provider
# of the default definition.
function pairwise! end

end # module