Skip to content

added note about laziness of operations to statistical functions #3293

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 2 commits into from
Jul 10, 2019
Merged

added note about laziness of operations to statistical functions #3293

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b4f1f76
added note about laziness of operations to statistical functions
corinnebosley Mar 6, 2019
dc6b239
license header
corinnebosley Mar 6, 2019
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
6 changes: 5 additions & 1 deletion lib/iris/analysis/stats.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# (C) British Crown Copyright 2013 - 2015, Met Office
# (C) British Crown Copyright 2013 - 2019, Met Office
#
# This file is part of Iris.
#
Expand Down Expand Up @@ -31,6 +31,8 @@
def _ones_like(cube):
"""
Return a copy of cube with the same mask, but all data values set to 1.

The operation is non-lazy.
Copy link
Member

@lbdreyer lbdreyer Mar 13, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

I may be missing some context here as to the purpose of this PR, but this line doesn't seem necessary to add.

I'm assuming your intention is to clarify which functions are lazy for the user. If that is the case, it is surely not necessary to add this to a private function, which won't be included in the documentation?

Copy link
Member

@rcomer rcomer Apr 4, 2019

Choose a reason for hiding this comment

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

I guess this note would be useful for the next developer who looks at the code, wanting to make the public function lazy?

"""
ones_cube = cube.copy()
ones_cube.data = np.ones_like(cube.data)
Expand Down Expand Up @@ -85,6 +87,8 @@ def pearsonr(cube_a, cube_b, corr_coords=None, weights=None, mdtol=1.,
Reference:
http://www.statsoft.com/textbook/glosp.html#Pearson%20Correlation

This operation is non-lazy.

"""

# Assign larger cube to cube_1
Expand Down