Skip to content

Instantly share code, notes, and snippets.

@JakobTischler

JakobTischler/normalize-in-range.js

Created August 11, 2021 09:55
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save JakobTischler/e413675838d3a549caaa9e0dae82de4c to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save JakobTischler/e413675838d3a549caaa9e0dae82de4c to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. JakobTischler revised this gist Aug 11, 2021. 1 changed file with 6 additions and 3 deletions.
    9 changes: 6 additions & 3 deletions normalize-in-range.js
    View file
    Original file line number Diff line number Diff line change
    @@ -1,5 +1,8 @@
    /**
    * Normalizes a `value` between `min` and `max` and then casts it onto a range between `rangeMin` (defaults to 0) and `rangeMax` (defaults to 1). The initial normalization can be clamped between 0 and 1 (`clamp`, defaults true). The return value describes where `value` would lay if `min` and `max` were represented by the `rangeMin` and `rangeMax` range.
    * Normalizes a `value` between `min` and `max` and then casts it onto a range between `rangeMin`
    * (defaults to 0) and `rangeMax` (defaults to 1). The initial normalization can be clamped between
    * 0 and 1 (`clamp`, defaults true). The return value describes where `value` would lay if `min`
    * and `max` were represented by the `rangeMin` and `rangeMax` range.
    *
    * Read as: "value is to min and max as result is to rangeMin and rangeMax"
    *
    @@ -20,12 +23,12 @@ const normalizeInRange = ((value, min, max, rangeMin = 0.0, rangeMax = 1.0, clam
    n = Math.max(Math.min(n, 1.0), 0.0);
    }
    const result = rangeMin + n * (rangeMax - rangeMin);

    // Test logging
    console.group('normalizeInRange');
    console.log({ value, min, max, rangeMin, rangeMax, clamp });
    console.log('Result:', result);
    console.groupEnd();

    return result;
    })(0.75, -4, 4, 100, 200);
  2. JakobTischler created this gist Aug 11, 2021.
    31 changes: 31 additions & 0 deletions normalize-in-range.js
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,31 @@
    /**
    * Normalizes a `value` between `min` and `max` and then casts it onto a range between `rangeMin` (defaults to 0) and `rangeMax` (defaults to 1). The initial normalization can be clamped between 0 and 1 (`clamp`, defaults true). The return value describes where `value` would lay if `min` and `max` were represented by the `rangeMin` and `rangeMax` range.
    *
    * Read as: "value is to min and max as result is to rangeMin and rangeMax"
    *
    * @param {number} value The value to cast.
    * @param {number} min The lower value of the normalization set. `min < max` must be true.
    * @param {number} max The upper value of the normalization set. `max > min` must be true.
    * @param {number} [rangeMin] The lower value of the representation range. Defaults to 0.
    * @param {number} [rangeMax] The upper value of the representation range. Defaults to 1.
    * @param {boolean} [clamp] If true, the normalization is clamped to between 0 and 1. Defaults to true.
    * @returns {number} The position the value would have if `min` and `max` were `rangeMin` and `rangeMax`.
    * @example value = 10, min = -20, max = 20, rangeMin = 0, rangeMax = 1, clamp = true. Returns: 0.75
    * @example value = 10, min = -20, max = 20, rangeMin = -1, rangeMax = 1, clamp = true. Returns: 0.5
    * @example value = -30, min = -20, max = 20, rangeMin = 0, rangeMax = 10, clamp = false. Returns: -2.5
    */
    const normalizeInRange = ((value, min, max, rangeMin = 0.0, rangeMax = 1.0, clamp = false) => {
    let n = (value - min) / (max - min);
    if (clamp) {
    n = Math.max(Math.min(n, 1.0), 0.0);
    }
    const result = rangeMin + n * (rangeMax - rangeMin);

    // Test logging
    console.group('normalizeInRange');
    console.log({ value, min, max, rangeMin, rangeMax, clamp });
    console.log('Result:', result);
    console.groupEnd();

    return result;
    })(0.75, -4, 4, 100, 200);