Merge pull request #1 from adam-rumpf/dev

Minor edits, and adding a couple of utility functions.

Author: adam-rumpf

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Adam Rumpf
+Copyright (c) 2021 Adam Rumpf
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -22,6 +22,7 @@ A variety of scripts dealing with sequences, functions, and sets, which may have
 Common array functions (such as searching and counting).
 
 * [`_array_count`](https://github.com/adam-rumpf/game-maker-scripts/blob/master/scripts/_array_count/_array_count.gml): Counts the number of occurrences of a specified value in an array.
+* [`_array_function`](https://github.com/adam-rumpf/game-maker-scripts/blob/master/scripts/_array_function/_array_function.gml): Applies a given function to every element of a given array, and returns an array of results.
 * [`_array_index`](https://github.com/adam-rumpf/game-maker-scripts/blob/master/scripts/_array_index/_array_index.gml): Finds the first index at which a specified value occurs in an array (or -1 if not found). An optional argument allows the search to begin from a specified index.
 * [`_array_max`](https://github.com/adam-rumpf/game-maker-scripts/blob/master/scripts/_array_max/_array_max.gml): Returns the maximum value (or the index of the maximum value) in an array.
 * [`_array_min`](https://github.com/adam-rumpf/game-maker-scripts/blob/master/scripts/_array_min/_array_min.gml): Returns the minimum value (or the index of the minimum value) in an array.
@@ -43,6 +44,7 @@ Numerical algorithms for computational mathematics.
 
 Common linear algebra algorithms for dealing with matrices and vectors. In all functions, _vectors_ are considered to be 1D arrays while _matrices_ are 2D arrays (i.e. arrays of arrays).
 
+* [`_coordinate_remap`](https://github.com/adam-rumpf/game-maker-scripts/blob/master/scripts/_coordinate_remap/_coordinate_remap.gml): Remaps a coordinate from one rectangular region to another.
 * [`_linear_solve`](https://github.com/adam-rumpf/game-maker-scripts/blob/master/scripts/_linear_solve/_linear_solve.gml): Solves a linear system of the form _Ax = b_ (using [Gaussian elimination with partial pivoting](https://en.wikipedia.org/wiki/Pivot_element)).
 * [`_matrix_multiply`](https://github.com/adam-rumpf/game-maker-scripts/blob/master/scripts/_matrix_multiply/_matrix_multiply.gml): Performs matrix-matrix, matrix-vector, and vector-vector multiplication.
 * [`_matrix_transpose`](https://github.com/adam-rumpf/game-maker-scripts/blob/master/scripts/_matrix_transpose/_matrix_transpose.gml): Transposes a 2D matrix.

scripts/_coordinate_remap/_coordinate_remap.gml

@@ -0,0 +1,23 @@
+/// @func _coordinate_remap(xi1, yi1, xi2, yi2, xf1, yf1, xf1, yf2, x, y)
+/// @desc Remaps a coordinate from one rectangular region to another.
+/// @param {real} xi1 Initial rectangular region's minimum x-value.
+/// @param {real} yi1 Initial rectangular region's minimum y-value.
+/// @param {real} xi2 Initial rectangular region's maximum x-value.
+/// @param {real} yi2 Initial rectangular region's maximum y-value.
+/// @param {real} xf1 Final rectangular region's minimum x-value.
+/// @param {real} yf1 Final rectangular region's minimum y-value.
+/// @param {real} xf2 Final rectangular region's maximum x-value.
+/// @param {real} yf2 Final rectangular region's maximum y-value.
+/// @param {real} x x-coordinate to be remapped.
+/// @param {real} y y-coordinate to be remapped.
+/// @return {real[]} Remapped coordinates of input point, as an ordered pair [x, y].
+
+function _coordinate_remap(xi1, yi1, xi2, yi2, xf1, yf1, xf2, yf2, xx, yy)
+{
+	// Calculate remapped coordinates
+	var xf, yf;
+	xf = ((xx - xi1)*(xf2 - xf1))/(xi2 - xi1) + xf1;
+	yf = ((yy - yi1)*(yf2 - yf1))/(yi2 - yi1) + yf1;
+	
+	return [xf, yf];
+}

scripts/_random_weighted_index/_random_weighted_index.gml

@@ -23,7 +23,7 @@ function _random_weighted_index(wt)
 
 	// Find which interval this number belongs to
 	var i = 0;
-	while (r > 0 && i < n)
+	while ((r > 0) && (i < n))
 	{
 		r -= wt[i];
 		i++;

scripts/_range/_range.gml

@@ -1,4 +1,4 @@
-/// @func _range(start, stop[, step]])
+/// @func _range(start, stop[, step])
 /// @desc Generates an array of equally-spaced values over a specified range with a specified step size.
 /// @param {real} start First value of array.
 /// @param {real} stop Final value of array (if the step size evenly divides the array; otherwise gives an upper bound to the final value).