Skip to content

Commit

Permalink
Merge pull request #87 from topolarity/ct/rm-random123
Browse files Browse the repository at this point in the history 
Remove `Random123` as a sub-module
  • Loading branch information
@sunoru
sunoru authored Aug 12, 2024
2 parents ab72a1e + f023f69 commit f7aa1ea
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 15 deletions.
3 changes: 1 addition & 2 deletions Project.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,13 @@ name = "RandomNumbers"
uuid = "e6cf234a-135c-5ec9-84dd-332b85af5143"
author = ["Sunoru <[email protected]>"]
repo = "https://github.com/JuliaRandom/RandomNumbers.jl.git"
version = "1.5.3"
version = "1.6.0"

[deps]
Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
Requires = "ae029012-a4dd-5104-9daa-d747884805df"

[compat]
Requires = "1"
julia = "1"

[extras]
Expand Down
1 change: 0 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ There are four RNG families in this package:
A class of RNG based on *exclusive or* and *bit shift*.

Note that `Random123` is now made a separate package as [Random123.jl](https://github.com/JuliaRandom/Random123.jl).
You can still use your old code with `RandomNumbers.Random123` as long as you import `Random123` manually.

## Usage

Expand Down
6 changes: 3 additions & 3 deletions docs/src/man/random123.md
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Random123 Family

```@meta
CurrentModule = RandomNumbers.Random123
CurrentModule = Random123
DocTestSetup = quote
using RandomNumbers.Random123
using Random123
end
```

Expand Down Expand Up @@ -69,7 +69,7 @@ For detailed usage of each RNG, please refer to the [library docs](@ref Random12

To use Random123, firstly import the module:
```julia
julia> using RandomNumbers.Random123
julia> using Random123
```

Take `Philox4x64` for example:
Expand Down
10 changes: 1 addition & 9 deletions src/RandomNumbers.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,14 @@ This module exports two types and four submodules:
- [`WrappedRNG`](@ref)
- [`PCG`](@ref)
- [`MersenneTwisters`](@ref)
- [`Random123`](random123.md#Random123.Random123)
- [`Xorshifts`](@ref)
"""
module RandomNumbers

export AbstractRNG
export WrappedRNG
export output_type, seed_type
export PCG, MersenneTwisters, Random123, Xorshifts
export PCG, MersenneTwisters, Xorshifts

include("common.jl")
include("utils.jl")
Expand All @@ -31,11 +30,4 @@ module RandomNumbers

export randfloat
include("randfloat.jl")

import Requires
function __init__()
# The code of Random123 has been moved to Random123.jl
Requires.@require Random123="74087812-796a-5b5d-8853-05524746bad3" import .Random123
end

end

6 comments on commit f7aa1ea

@sunoru
Copy link
Member Author

@sunoru sunoru commented on f7aa1ea Aug 12, 2024

Choose a reason for hiding this comment

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

@JuliaRegistrator register

Breaking change: The use of RandomNumbers.Random123 is no longer supported. Please directly use the Random123 package.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Registration pull request created: JuliaRegistries/General/112988

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v1.6.0 -m "<description of version>" f7aa1ea41e63ccedc890483063bdf6cc59688dd3
git push origin v1.6.0

@sunoru
Copy link
Member Author

@sunoru sunoru commented on f7aa1ea Aug 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

@JuliaRegistrator register

Release notes:

Breaking changes

  • The use of RandomNumbers.Random123 is no longer supported. Please directly use the Random123 package.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Registration pull request updated: JuliaRegistries/General/112988

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v1.6.0 -m "<description of version>" f7aa1ea41e63ccedc890483063bdf6cc59688dd3
git push origin v1.6.0

@sunoru
Copy link
Member Author

@sunoru sunoru commented on f7aa1ea Aug 12, 2024

Choose a reason for hiding this comment

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

@JuliaRegistrator register

Release notes:

Breaking changes

  • The use of RandomNumbers.Random123 is no longer supported. Please directly use the Random123 package.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Registration pull request updated: JuliaRegistries/General/112988

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v1.6.0 -m "<description of version>" f7aa1ea41e63ccedc890483063bdf6cc59688dd3
git push origin v1.6.0

Please sign in to comment.