RepoMirrors/osu
1
0
Fork 0
mirror of https://github.com/ppy/osu synced 2025-02-26 15:40:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Move algorithm description to remarks section of xmldoc

Browse Source
This commit is contained in:
Bartłomiej Dach 2024-02-05 18:57:55 +01:00
parent a5aeb2ff9e
commit 7b03bebd5f
No known key found for this signature in database
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
osu.Game/Rulesets/Scoring/HitEventExtensions.cs
View File

@ -11,8 +11,11 @@ namespace osu.Game.Rulesets.Scoring
public static class HitEventExtensions
{
/// <summary>
/// Calculates the "unstable rate" for a sequence of <see cref="HitEvent"/>s using Welford's online algorithm.
/// Calculates the "unstable rate" for a sequence of <see cref="HitEvent"/>s.
/// </summary>
/// <remarks>
/// Uses <a href="https://en.wikipedia.org/wiki/Algorithms_for_calculating_variance#Welford's_online_algorithm">Welford's online algorithm</a>.
/// </remarks>
/// <returns>
/// A non-null <see langword="double"/> value if unstable rate could be calculated,
/// and <see langword="null"/> if unstable rate cannot be calculated due to <paramref name="hitEvents"/> being empty.