dave/openttd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

(svn r25893) -Fix: Document RandomRange and change misleading parameter name 'max' in random functions.

Browse Source
This commit is contained in:
fonsinchen
2013-10-20 14:48:08 +00:00
parent 8d53e23b6c
commit e037a8bea9
2 changed files with 22 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/core/random_func.cpp
View File

@@ -29,13 +29,14 @@ uint32 Randomizer::Next()
}
/**
* Generate the next pseudo random number scaled to max
* @param max the maximum value of the returned random number
* @return the random number
* Generate the next pseudo random number scaled to \a limit, excluding \a limit
* itself.
* @param limit Limit of the range to be generated from.
* @return Random number in [0,\a limit)
*/
uint32 Randomizer::Next(uint32 max)
uint32 Randomizer::Next(uint32 limit)
{
return ((uint64)this->Next() * (uint64)max) >> 32;
return ((uint64)this->Next() * (uint64)limit) >> 32;
}
/**
@@ -75,8 +76,8 @@ uint32 DoRandom(int line, const char *file)
return _random.Next();
}
uint32 DoRandomRange(uint32 max, int line, const char *file)
uint32 DoRandomRange(uint32 limit, int line, const char *file)
{
return ((uint64)DoRandom(line, file) * (uint64)max) >> 32;
return ((uint64)DoRandom(line, file) * (uint64)limit) >> 32;
}
#endif /* RANDOM_DEBUG */