Add - Tics Function #8

TestSubjector · 2017-03-14T20:55:30Z

TODO.md: remove 'tics' from list.
docs/src/ref.md: add "tics" entry to the manual.
src/utils.jl: Add tics entry to "utils".
src/tics.jl: Contains tics function.
test/util-tests.jl: Include tests

Note - The test and examples values are random dummy values,
as I couldn't find any proper example sets to use.

* TODO.md: remove 'tics' from list. * docs/src/ref.md: add "tics" entry to the manual. * src/utils.jl: Add tics entry to "utils". * src/tics.jl: Contains tics function. * test/util-tests.jl: Include tests Note - The test and examples values are random dummy values, as I couldn't find any proper example sets to use.

* src/tics.jl: Re-added spacing in the function info section for readibility, which had somehow gotten lost in transition.

codecov-io · 2017-03-14T21:08:03Z

Codecov Report

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

@@            Coverage Diff             @@
##           master       #8      +/-   ##
==========================================
+ Coverage   99.78%   99.79%   +0.01%     
==========================================
  Files          57       58       +1     
  Lines         943      999      +56     
==========================================
+ Hits          941      997      +56     
  Misses          2        2

Impacted Files	Coverage Δ
src/tics.jl	`100% <100%> (ø)`

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 ae3fdf7...3094adb. Read the comment docs.

giordano · 2017-03-14T21:16:48Z

src/tics.jl

+# => (0.66,2.0)
+tics(30, 60, 12, 2, true)
+# => (2.75,30.0)
+


You missed to close the ``` block ;-)

giordano · 2017-03-14T21:39:21Z

Thanks again. Some comments:

Contrary to many other languages, in Julia you should avoid using Float64 literals when you wrote generic code. Instead use integers or rational numbers when possible, see http://docs.julialang.org/en/latest/manual/style-guide.html#Avoid-using-floats-for-numeric-literals-in-generic-code-when-possible-1 For example, if input is in Float32 or BigFloat type, you'd run either into type-instabilities or loss of accuracy, or both. For the BigFloat case, this happens because decimal literals are converted to Float64 before being converted to BigFloat, see http://docs.julialang.org/en/latest/stdlib/numbers.html#Base.MPFR.BigFloat. Honestly, I don't expect that many people will be using this function with types different from Float64, but I think that starting from the beginning to write high-quality code is a good exercise for the future ;-)
When I started the projected, Julia REPL didn't have prompt pasting (see RFC: remove repl prompt prefix before parsing JuliaLang/julia#17599). This feature, that will be present in Julia 0.6, will make it super-easy to copy and past code from the REPL, without having to remove the prompt or hide the result of evaluation in a comment, like what I did in the examples of this package. Now you can happily copy-and-past the examples from the REPL and I suggest you to do this for this file.

giordano · 2017-03-14T21:40:17Z

src/tics.jl

+
+    numtics = numx/ticsize
+    if ra
+        mul = 4.0


Here, and in the other assignments below where only numbers are involved, you can write T(4) instead of 4.0.

Apologies, I didn't realise the significance of T(number) earlier.
Added T() to all assignment areas.

Don't worry, no problem, sorry if I wasn't clear enough ;-)

giordano · 2017-03-14T21:41:38Z

src/tics.jl

+    elseif incr >= 0.5
+        incr = 1.0
+    elseif incr >= 0.25
+        incr = 0.5


In case of decimal numbers, use T(1//2).

giordano · 2017-03-15T08:42:14Z

src/tics.jl

+tics(radec_min::Real, radec_max::Real, numx::Real,
+     ticsize::Real, ra::Bool=false) =
+        _tics(promote(float(radec_min), float(radec_max), float(numx),
+float(ticsize))..., ra)


Just a nitpick: please insert a line break at the end of the last line, and indent it.

* src/tics.jl: Removed float for numeric literals Fixed indentation, added promt pasting * test/utils-tests.jl: In brief, brute forced for test coverage Potential Problem: The function has a unstable return type. Possible annotation?

TestSubjector · 2017-03-15T14:08:38Z

Committed fixes. As always, thanks for the help!

Instead use integers or rational numbers when possible.

The commit reflects the same, however running @code_warntype states that the function now has a unstable return type (Union{Int64, Rational{Int64}}) . The style guide recommends that I should annotate it. Thoughts?

When I started the projected, Julia REPL didn't have prompt pasting (see JuliaLang/julia#17599). This feature, that will be present in Julia 0.6,

I noticed the prompt pasting in a few of the files like month_cnv.jl, however they weren't working for me because apparently I was still running Julia 0.5. Realised that after you pointed out the version condition.

Another query, should we implement the feature of prompt pasting in all the existing function files? (As a minor todo/issue)

giordano · 2017-03-15T14:18:24Z

As I suggested in the comments to the code, you can use T(number) to convert the integer or rational number to the T type, so that incr will always have type T with the right accuracy (guaranteed by the fact that number is Integer or Rational) and the function would be type stable.

* src/tics.jl: Implemented T(number) for accuracy and type stabiltiy * test/utils-tests.jl: Edited tests to accommodate changes in tics.jl

TestSubjector added 2 commits March 15, 2017 02:23

Small fix for readibility

4c3a228

* src/tics.jl: Re-added spacing in the function info section for readibility, which had somehow gotten lost in transition.

giordano reviewed Mar 14, 2017

View reviewed changes

src/tics.jl Outdated

# => (0.66,2.0)

tics(30, 60, 12, 2, true)

# => (2.75,30.0)

Copy link

Member

giordano Mar 14, 2017

Choose a reason for hiding this comment

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

You missed to close the ``` block ;-)

giordano reviewed Mar 14, 2017

View reviewed changes

src/tics.jl Outdated

elseif incr >= 0.5

incr = 1.0

elseif incr >= 0.25

incr = 0.5

Copy link

Member

giordano Mar 14, 2017

Choose a reason for hiding this comment

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

In case of decimal numbers, use T(1//2).

giordano reviewed Mar 15, 2017

View reviewed changes

Improvements, fixes and increasing test coverage

5f22721

* src/tics.jl: Removed float for numeric literals Fixed indentation, added promt pasting * test/utils-tests.jl: In brief, brute forced for test coverage Potential Problem: The function has a unstable return type. Possible annotation?

Use T() to convert numeric literals to type T

3094adb

* src/tics.jl: Implemented T(number) for accuracy and type stabiltiy * test/utils-tests.jl: Edited tests to accommodate changes in tics.jl

giordano merged commit 27279cc into JuliaAstro:master Mar 15, 2017

TestSubjector deleted the tics branch March 16, 2017 03:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add - Tics Function #8

Add - Tics Function #8

TestSubjector commented Mar 14, 2017

codecov-io commented Mar 14, 2017 •

edited

giordano Mar 14, 2017

giordano commented Mar 14, 2017

giordano Mar 14, 2017 •

edited

TestSubjector Mar 15, 2017

giordano Mar 15, 2017

giordano Mar 14, 2017

giordano Mar 15, 2017

TestSubjector commented Mar 15, 2017 •

edited

giordano commented Mar 15, 2017 •

edited

Add - Tics Function #8

Add - Tics Function #8

Conversation

TestSubjector commented Mar 14, 2017

codecov-io commented Mar 14, 2017 • edited

Codecov Report

giordano Mar 14, 2017

Choose a reason for hiding this comment

giordano commented Mar 14, 2017

giordano Mar 14, 2017 • edited

Choose a reason for hiding this comment

TestSubjector Mar 15, 2017

Choose a reason for hiding this comment

giordano Mar 15, 2017

Choose a reason for hiding this comment

giordano Mar 14, 2017

Choose a reason for hiding this comment

giordano Mar 15, 2017

Choose a reason for hiding this comment

TestSubjector commented Mar 15, 2017 • edited

giordano commented Mar 15, 2017 • edited

codecov-io commented Mar 14, 2017 •

edited

giordano Mar 14, 2017 •

edited

TestSubjector commented Mar 15, 2017 •

edited

giordano commented Mar 15, 2017 •

edited