vsl icon indicating copy to clipboard operation
vsl copied to clipboard

refactor(noise): fix naming issues / file organisation

Open PottierLoic opened this issue 1 year ago • 2 comments

This PR cleans up some naming issues that slipped through when I added Perlin and Simplex noise.

Some functions were named like noisetype_dimension, while others used noisetypedimensions without underscore. It got a bit confusing, so I’ve fixed everything to be consistent now.

I also combined the perlin_2d and perlin_3d files into a single perlin file to match how the Simplex code is organized. Same thing for the test files.

Summary by CodeRabbit

  • New Features

    • Introduced Perlin noise generation functions for 2D and 3D coordinates.
    • Added a setup function for initializing the random number generator.
    • Added test functions for validating Perlin noise generation.
  • Bug Fixes

    • Updated parameter naming for clarity in various methods.
  • Chores

    • Removed outdated Perlin noise modules and their corresponding test files.
    • Renamed gradient functions for consistency across the noise generation module.
    • Updated expected output values in test functions for accuracy.

PottierLoic avatar Nov 28 '24 15:11 PottierLoic

Walkthrough

The changes in this pull request involve modifications to the noise module, primarily focusing on renaming parameters and functions for clarity. The Generator struct's randomize method parameter was renamed from generator to gen. Additionally, new functions for 2D and 3D Perlin noise generation were introduced, while previous implementations of 2D and 3D Perlin noise were removed. The simplex module also underwent similar renaming changes, ensuring consistency across the codebase.

Changes

File Change Summary
noise/noise.v Renamed generator parameter to gen in randomize method. Added functions for Perlin noise: perlin_2d, perlin_3d, perlin_grad_2d, perlin_grad_3d, lerp, fade.
noise/perlin.v New file implementing Perlin noise generation functions for 2D and 3D coordinates.
noise/perlin2d.v Deleted file containing 2D Perlin noise generation function and associated helpers.
noise/perlin2d_test.v Deleted test file for the 2D Perlin noise generator.
noise/perlin3d.v Deleted file containing 3D Perlin noise generation function and associated helpers.
noise/perlin3d_test.v Deleted test file for the 3D Perlin noise generator.
noise/perlin_test.v New test module added with functions for testing 2D and 3D Perlin noise generation.
noise/simplex.v Renamed gradient functions and updated Generator parameter name to gen in simplex functions.
noise/simplex_test.v Renamed generator variable to gen in simplex test functions.
noise/test_utils.v New module added with function setup_generator for initializing a Generator.

Possibly related PRs

  • vlang/vsl#207: The changes in the main PR regarding the Generator struct and its methods are directly related to the modifications in the Simplex noise implementation, which also utilizes the Generator struct for handling permutation tables. The renaming of the generator parameter to gen in the randomize method aligns with similar changes made in the Simplex noise PR.

🐇 In the land of noise, where rabbits play,
A generator's name changed, hip-hip-hooray!
With Perlin and Simplex, they dance in the night,
Creating soft whispers, oh what a delight!
So hop along, friends, let the noise be your guide,
In this warren of wonders, let creativity glide! 🐇


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Nov 28 '24 15:11 coderabbitai[bot]

I also renamed the grad_Xd functions to avoid conflicts since Simplex and Perlin use different versions of these.

PottierLoic avatar Nov 28 '24 15:11 PottierLoic