MathUtil - Revision history

Redspark: Added missing functions and marked some as MiniMicro only.

2025-04-05T04:23:10Z

Added missing functions and marked some as MiniMicro only.

Redspark at 00:46, 5 April 2025

2025-04-05T00:46:55Z

Duck Mim: degToRad("radians") ----> degToRad(''degrees'')

2025-04-04T20:29:05Z

degToRad("radians") ----> degToRad(''degrees'')

Redspark: Added to Sys Modules Category

2025-03-31T16:09:39Z

Added to Sys Modules Category

JoeStrout: Created page with "In Mini Micro, mathUtil is an import module in the /sys/lib directory. It provides various additional math-related functions and constants. Like all th..."

2021-08-26T22:32:18Z

Created page with "In Mini Micro, <c>mathUtil</c> is an import module in the <c>/sys/lib</c> directory. It provides various additional math-related functions and constants. Like all th..."

New page

In [[Mini Micro]], <c>mathUtil</c> is an [[import]] module in the <c>/sys/lib</c> directory. It provides various additional math-related functions and constants.

Like all the modules in <c>/sys/lib</c>, the best documentation for mathUtil is the source code (<c>/sys/lib/mathUtil.ms</c>) itself. But this page summarizes the content in more concise form.

== Constant ==

{| class="wikitable"
|-
! Name !! Value / Purpose
|-
| mathUtil.e || [https://en.wikipedia.org/wiki/E_(mathematical_constant) Euler's number], roughly 2.718; base of natural logarithms
|}

== Methods ==

The following methods are normally accessed via the <c>mathUtil</c> prefix, e.g. <c>mathUtil.radToDeg(pi)</c>.

{| class="wikitable"
|-
! Method !! Returns
|-
| ln(''x'') || natural logarithm of ''x''
|-
| radToDeg(''radians'') || converts ''radians'' into degrees
|-
| degToRad(''radians'') || converts ''degrees'' into radians
|-
| moveTowards(''num'', ''targetNum'', ''maxChange''=1) || returns a value closer to ''targetNum'' from ''num'', differing from ''num'' by no more than ''maxChange'')
|-
| moveTowardsXY(''mover'', ''target'', ''maxDist''=1) || like <c>moveTowards</c>, but mutates map ''mover'' to approach ''target'', each with ''x'' and ''y'' properties (e.g., a [[Sprite]])
|-
| distance(''p1'', ''p2'') || find the distance between two points; each may be a map containing ''x'' and ''y', or an [''x'', ''y''] list
|-
| lerp(''a'', ''b'', ''t'') || returns a value some portion ''t'' of the way from ''a'' to ''b''
|-
| lerp2d(''p1'', ''p2'', ''t'') || same as <c>lerp</c>, but on 2d points (maps or lists)
|-
| proportionAlongLine(''endA'', ''endB'', ''p'') || returns how far ''p'' is along the line from ''endA'' to ''endB''
|-
| nearestPointOnLine(''endA'', ''endB'', ''p'') || returns closest point to ''p'' on the line from ''endA'' to ''endB'' as an [''x'', ''y''] list
|-
| nearestPointOnLineSegment(''endA'', ''endB'', ''p'') || same as <c>nearestPointOnLine</c>, but limited to not go beyond the range from ''endA'' to ''endB''
|-
| distanceToLine(''endA'', ''endB'', ''p'') || returns distance from ''p'' to the line from ''endA'' to ''endB''
|-
| distanceToLineSegment(''endA'', ''endB'', ''p'') || same as <c>distanceToLine</c>, but limited to not go beyond the range from ''endA'' to ''endB''
|-
| polyPerimeter(''polygon'') || returns total distance around ''polygon'' (given as list of [''x'', ''y'']] points)
|-
| polyArea(''polygon'') || returns area of ''polygon'' (given as list of [''x'', ''y'']] points)
|-
| pointInPoly(''point'', ''polygon'') || returns true if ''point'' (an [''x'', ''y''] point) is contained within ''polygon''; or if ''point'' is a list of ['x'', ''y''] points, returns true if any of those points are within ''polygon''
|-
| offsetPoly(''polygon'', ''delta'') || returns a new polygon by insetting/growing ''polygon'' by the given amount
|-
| shiftPoly(''polygon'', ''dx'', ''dy'') || returns a new polygon by translating ''polygon'' by the given amounts
|-
| rotatePoly(''polygon'', ''degrees'') || returns a new polygon by rotating ''polygon'' by ''degrees'' clockwise
|-
| randNormal(''mean''=0, ''stddev''=1) || returns a [https://en.wikipedia.org/wiki/Normal_distribution normally-distributed] random number
|-
| randRange(''min'', ''max'') || returns a random number between ''min'' and ''max''
|-
| dice(''numberOfDice''=1, ''sides''=6) || roll ''numberOfDice'' dice, each with values from 1 to ''sides'', and return the sum
|-
| clamp(''x'', ''minval''=0, ''maxval'=1) || return ''x'' limited to the range ''minval'' to ''maxval''
|-
| numToStr(''n'', ''precision'') || convert ''n'' to a string, with a specified number of digits past the decimal place, with trailing zeros
|}

== Example ==

The following program creates a sprite, then uses <c>mathUtil.moveTowardsXY</c> to make it chase the mouse.

<ms>import "mathUtil"
s = new Sprite
s.image = file.loadImage("/sys/pics/Wumpus.png")
display(4).sprites.push s
while true
mathUtil.moveTowardsXY s, mouse, 10
yield
end while</ms>

[[Category:Mini Micro]]

@@ Line 82: / Line 82: @@
 end while</ms>
+[[Category:Sys Modules]]
 [[Category:Mini Micro]]
-[[Category:Sys Modules]]
+[[Category:Command-Line_MiniScript]]

← Older revision		Revision as of 16:09, 31 March 2025
Line 84:		Line 84:

	[[Category:Mini Micro]]		[[Category:Mini Micro]]
		+	[[Category:Sys Modules]]

@@ Line 45: / Line 45: @@
 |-
 | distanceToLineSegment(''endA'', ''endB'', ''p'') || same as <c>distanceToLine</c>, but limited to not go beyond the range from ''endA'' to ''endB''
 |-
 | polyPerimeter(''polygon'') || returns total distance around ''polygon'' (given as list of [''x'', ''y'']] points)
@@ Line 65: / Line 83: @@
 |-
 | clamp(''x'', ''minval''=0, ''maxval'=1) || return ''x'' limited to the range ''minval'' to ''maxval''
 |-
 | numToStr(''n'', ''precision'') || convert ''n'' to a string, with a specified number of digits past the decimal place, with trailing zeros

@@ Line 24: / Line 24: @@
 | radToDeg(''radians'') || converts ''radians'' into degrees
 |-
-| degToRad(''radians'') || converts ''degrees'' into radians
+| degToRad(''degrees'') || converts ''degrees'' into radians
 |-
 | moveTowards(''num'', ''targetNum'', ''maxChange''=1) || returns a value closer to ''targetNum'' from ''num'', differing from ''num'' by no more than ''maxChange'')