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

mixed improvements #73

Merged
merged 2 commits into from
Dec 12, 2017
Merged

mixed improvements #73

merged 2 commits into from
Dec 12, 2017

Conversation

schillic
Copy link
Member

@schillic schillic commented Dec 9, 2017

  • added output types to all functions
  • turned shorthand function style into function ... end blocks (except for constructors)
  • renamed is_contained ->
  • checked Add unit tests for d=0 in lazy sets #49
  • minor doc fixes

@mforets
Copy link
Member

mforets commented Dec 10, 2017

some comments:

  • we can have iscontained (or is_contained ?) as an alias.

  • some functions enter in 80 characters => they fit nicely as one-liners.. is there any doc-related reason for the change? just aesthetics?

  • the Output block of sign_cadlag is wrong, should say: 1 if x≥0, -1 otherwise. shall we update it here? maybe add too:

### Notes

This is the sign function right-continuous at zero (see [cadlag function](https://en.wikipedia.org/wiki/C%C3%A0dl%C3%A0g)). It can be used with vector-valued arguments via the dot operator.

@schillic
Copy link
Member Author

schillic commented Dec 10, 2017

we can have iscontained (or is_contained ?) as an alias.

We already have in, I think this suffices.

some functions enter in 80 characters => they fit nicely as one-liners

Citation needed :) I saw one case in convex_hull_algorithms.jl.
I prefer to break documentation sentences after the period to avoid moving everything around with a later change.

- turned shorthand function style into `function ... end` blocks (except for constructors)
- renamed `is_contained` -> `∈`
- checked #49
- minor doc fixes
@schillic
Copy link
Member Author

the Output block of sign_cadlag is wrong

I fixed it here.

@mforets
Copy link
Member

mforets commented Dec 10, 2017

We already have in, I think this suffices.

ok. it's the same as Base.\in ? or in should be declared too? i didn't find it in this commit

Citation needed :)

i don't have one, no problem :)

@schillic
Copy link
Member Author

We already have in, I think this suffices.

ok. it's the same as Base.\in ? or in should be declared too? i didn't find it in this commit

Sorry, I should have said that. It seems to work automatically. It just aliases and then calls the right function.

@mforets mforets merged commit 262914f into master Dec 12, 2017
@schillic schillic deleted the schillic/output_types branch December 12, 2017 11:59
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.

None yet

2 participants