Quenty / Quenty/NevermoreEngine

Issues with Utilities/Probability

Open
#60 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue help wanted
Dominant language
Lua
Stars
610
Forks
144
Avg merge
1d 20h
Merged PRs (30d)
12

Description

I've been extending Utilities/Probability for a little bit with additional probability distribution sampler functions and have a couple of gripes:

  • As far as I can tell Utilities/Probability is currently a normal distribution single-sampler and doesn't actually deal with larger concepts involving probability. This makes the module name appear to be a misnomer. I propose that it be renamed Utilities/Distributions, Utilities/Stats, or something similar.

  • Further, the inclusion of the Distribution suffix in the module's functions is redundant. We already know that the module is about "Probability" and so exported function names should be obvious.

  • BoxMuller is an implementation detail that should not be exposed to module consumers.

  • Using single-sampler functions, functions that only sample one value from the distribution in question, does not allow us to abuse the strengths of accept-reject sampling methods to their fullest.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review Utilities/Probability and its exported sampler functions to understand the current module scope, naming, and BoxMuller exposure. The work is complete when the module structure and public API are agreed on, including support for sampling multiple values rather than only single samples.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
game-dev
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.