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.

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

Jump to bottom

Prepare for registration #7

Merged
merged 2 commits into from
Dec 21, 2021
Merged

Prepare for registration #7

merged 2 commits into from
Dec 21, 2021

Commits on Dec 21, 2021

  1. Add example usages in documentation

    @jmert
    jmert committed Dec 21, 2021
    Configuration menu
    Copy the full SHA
    cabceee View commit details
    Browse the repository at this point in the history

  2. Separate low-level and high-level mmap wrappers to separate functions 

    This cleans up the method list for the intended user-facing `mmap`
function just a little bit --- namely, the function signature
involving a `RawFD` argument is no longer shown.

Simultaneously, we slightly relax the type constraints on all of the
high-level `mmap` methods to accept any `<:Array{T}` type so that
both specific-shape arrays (i.e. `Vector{T}`, `Matrix{T}`) and the
generic `Array{T}` argument can be used in user code to do the same
thing.

(Only the number of dimensions arguments matters in the end, so the
confusing `UnixMmap.mmap(Vector{Float64}, (3, 64))` actually returns a
matrix, but I find that less objectionable than not permitting
`UnixMmap.mmap(Matrix{Float64}, (3, 64))` to even work.)
    @jmert
    jmert committed Dec 21, 2021
    Configuration menu
    Copy the full SHA
    22b9318 View commit details
    Browse the repository at this point in the history