Skip to content
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.

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

plotter: Implement XYers interface for polygons #555

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

ctessum
Copy link
Contributor

@ctessum ctessum commented May 26, 2019

This makes it possible for external types to implement the interface
without copying all data points.

Fixes #442.

Please take a look.

This makes it possible for external types to implement the interface 
without copying all data points.
@codecov-io
Copy link

Codecov Report

Merging #555 into master will increase coverage by 0.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #555      +/-   ##
==========================================
+ Coverage   69.28%   69.29%   +0.01%     
==========================================
  Files          52       52              
  Lines        5339     5341       +2     
==========================================
+ Hits         3699     3701       +2     
  Misses       1468     1468              
  Partials      172      172
Impacted Files Coverage Δ
plotter/polygon.go 91.93% <100%> (ø) ⬆️
plotter/plotter.go 72.22% <100%> (+0.79%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e2840ee...ccfad0c. Read the comment docs.

2 similar comments
@codecov-io
Copy link

codecov-io commented May 26, 2019

Codecov Report

Merging #555 into master will increase coverage by 0.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #555      +/-   ##
==========================================
+ Coverage   69.28%   69.29%   +0.01%     
==========================================
  Files          52       52              
  Lines        5339     5341       +2     
==========================================
+ Hits         3699     3701       +2     
  Misses       1468     1468              
  Partials      172      172
Impacted Files Coverage Δ
plotter/polygon.go 91.93% <100%> (ø) ⬆️
plotter/plotter.go 72.22% <100%> (+0.79%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e2840ee...ccfad0c. Read the comment docs.

@codecov-io
Copy link

Codecov Report

Merging #555 into master will increase coverage by 0.01%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #555      +/-   ##
==========================================
+ Coverage   69.28%   69.29%   +0.01%     
==========================================
  Files          52       52              
  Lines        5339     5341       +2     
==========================================
+ Hits         3699     3701       +2     
  Misses       1468     1468              
  Partials      172      172
Impacted Files Coverage Δ
plotter/polygon.go 91.93% <100%> (ø) ⬆️
plotter/plotter.go 72.22% <100%> (+0.79%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e2840ee...ccfad0c. Read the comment docs.

// Len returns the number of XYers.
Len() int

// LenAt returns the length of XYer i.
Copy link
Member

Choose a reason for hiding this comment

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

Is there a reason to not define this as

type XYers interface {
    // Len returns the number of XYers.
    Len() int

    // XYer returns the XYer at position i.
    XYer(i int) XYer
}

This seems simpler for the user to create if needed.

Copy link
Contributor Author

@ctessum ctessum May 28, 2019

Choose a reason for hiding this comment

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

My understanding is that if the interface returns plotter.XYer, then every type that implements it also needs to return plotter.XYer (returning a different interface with the same signature is not allowed). So every package that implements this interface would have to import plotter, and the same interface could never really be used for anything else.

This problem is avoided if the interface only includes built-in types.

For my specific use case, I have a general purpose geometry library and I'm trying to make it convenient to plot the polygons, but I don't really want to include plotter as a dependency.

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, OK. The API is not very nice like this though. I'll let someone else comment. @sbinet?

Copy link
Member

Choose a reason for hiding this comment

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

just a quick note to say I haven't forgotten about this.
I'll circle back to it before the end of the week.

Copy link
Member

Choose a reason for hiding this comment

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

I'd be more in favour of Dan's API as well.

I understand you don't want plotter as a dependency of github.com/ctessum/geom, and I agree it isn't great for the separation of concerns (or just the sheer amount of dependencies that come with gonum/plot.)
I also have had that concern and this kind of issue for my hep/hbook package that deals with histograms, but just the statistical aspects of histograms (1D, 2D, ...), not dealing with actually displaying them.

I didn't want hbook to be tied to a specific graphical library having been bitten by this kind of hard dependency in the (C++) particle physics world.
what I did was to create a separate package would depend on hep/hbook and gonum/plot to hold types that would implement the needed interfaces for gonum/plot to work, wrapping hep/hbook values. (it's hep/hplot: https://godoc.org/go-hep.org/x/hep/hplot)

wouldn't this kind of approach (the usual additional indirection switcheroo trick) work for you as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It seems to me like that would result in a worse overall API experience, and I feel like there's a lot to be said for the interfaces only returning built-in types, but if that's the consensus, I'm alright with it I guess.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

plotter: NewPolygon should take an interface rather than a list of interfaces
4 participants