Skip to content

Added code backticks to bracket ranges in stochtree::random #118

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

Merged
merged 1 commit into from
Dec 3, 2024
Merged

Added code backticks to bracket ranges in stochtree::random #118

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions include/stochtree/random.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ class Random {
x = seed;
}
/*!
* \brief Generate random integer, int16 range. [0, 65536]
* \brief Generate random integer, int16 range. `[0, 65536]`
* \param lower_bound lower bound
* \param upper_bound upper bound
* \return The random integer between [lower_bound, upper_bound)
Expand All @@ -54,17 +54,17 @@ class Random {

/*!
* \brief Generate random float data
* \return The random float between [0.0, 1.0)
* \return The random float between `[0.0, 1.0)`
*/
inline float NextFloat() {
// get random float in [0,1)
// get random float in `[0,1)`
return static_cast<float>(RandInt16()) / (32768.0f);
}
/*!
* \brief Sample K data from {0,1,...,N-1}
* \brief Sample K data from `{0,1,...,N-1}`
* \param N
* \param K
* \return K Ordered sampled data from {0,1,...,N-1}
* \return K Ordered sampled data from `{0,1,...,N-1}`
*/
inline std::vector<int> Sample(int N, int K) {
std::vector<int> ret;
Expand Down
Loading