{"id":120,"date":"2011-09-12T22:36:11","date_gmt":"2011-09-13T02:36:11","guid":{"rendered":"http:\/\/www.jetmore.org\/john\/blog\/?p=120"},"modified":"2012-05-11T15:15:35","modified_gmt":"2012-05-11T19:15:35","slug":"arduinos-map-function-and-numeric-distribution","status":"publish","type":"post","link":"https:\/\/www.jetmore.org\/john\/blog\/2011\/09\/arduinos-map-function-and-numeric-distribution\/","title":{"rendered":"Arduino’s map() Function and Numeric Distribution"},"content":{"rendered":"

The Arduino map() function<\/a> is an interesting beast. Very technically it works exactly as its documented to work, but not the way almost every example uses it.<\/p>\n

Here’s an example you can find in hundreds of sketches online, including the actual documentation for map():<\/p>\n

\r\nval = map(val, 0, 1023, 0, 255);\r\n<\/pre>\n
This is a simple map, and one would expect that every four ticks on the input would map to one tick on the output (that is, {0,1,2,3} -> 0, {4,5,6,7} -> 1, etc). But that’s not what the function above actually does.<\/p>\n
To show the issue, let’s make the output range smaller (but still an even divisor):<\/p>\n
\r\nval = map(val, 0, 1023, 0, 15);\r\n<\/pre>\n
This should result in an even distribution, 64 input ticks per one output tick. To test this, I wrote a quick script implementing the Arduino map logic (which they were nice enough to document):<\/p>\n
\r\nlong map(long x, long in_min, long in_max, long out_min, long out_max)\r\n{\r\n  return (x - in_min) * (out_max - out_min) \/ (in_max - in_min) + out_min;\r\n}\r\n<\/pre>\n
The script prints a table of output values and the number of times that value was returned. Here’s the output for map(?, 0, 1023, 0, 15) for each value in 0..1023:<\/p>\n
\r\nmap(0..1023, 0, 1023, 0, 15);\r\n  0   69\r\n  1   68\r\n  2   68\r\n  3   68\r\n  4   68\r\n  5   69\r\n  6   68\r\n  7   68\r\n  8   68\r\n  9   68\r\n 10   69\r\n 11   68\r\n 12   68\r\n 13   68\r\n 14   68\r\n 15    1\r\n<\/pre>\n
That’s definitely not an even distribution. Now here’s a really stark example:<\/p>\n
\r\nmap(0..1023, 0, 1023, 0, 1);\r\n  0 1023\r\n  1    1\r\n<\/pre>\n
That’s a pretty egregious imbalance.<\/p>\n
I mentioned earlier that the function’s actually working how it’s documented to work, just not how it’s usually used in examples. The map() docs state that “[t]he map() function uses integer math so will not generate fractions, when the math might indicate that it should do so. Fractional remainders are truncated, and are not rounded or averaged.”<\/p>\n
This completely makes sense – if you imagine a range of 1024 values between 0 and one, all of them will be less than 1 except the last value, and since it’s integer arithmetic, all the less-than-1 values are 0.<\/p>\n
The solution is fairly simple – increase the in_max and out_max args by one more than the actual maximum value (and then wrap the output in constrain(), which you ought to have done anyway). It’s fairly easy to work through why this works in your head, but here are the same examples I gave above with the increased maximums:<\/p>\n
\r\nmap(0..1023, 0, 1024, 0, 2);\r\n  0   512\r\n  1   512\r\nmap(0..1023, 0, 1024, 0, 16);\r\n  0   64\r\n  1   64\r\n  2   64\r\n  3   64\r\n  4   64\r\n  5   64\r\n  6   64\r\n  7   64\r\n  8   64\r\n  9   64\r\n 10   64\r\n 11   64\r\n 12   64\r\n 13   64\r\n 14   64\r\n 15   64\r\n<\/pre>\n
I have worked through this and I now understand how to get the values I want out of constrain. What I don’t know, however, is why the docs and the examples don’t address this issue. I know I’m not the first person to find this issue because I’ve found sketches on the internet where people are doing this (and they’re doing it in a way that leads me to believe they’re doing it on purpose), but I couldn’t get Google to show me any pages where someone actually addresses this point. I wonder why?<\/p>\n
As for why I was looking into this, I was playing around with a couple of pots and an LCD, making a fakey etch-a-sketch using the 2-row LCD I have for such things. I could not figure out why my vertical control would only drop me down a line when I had the pot turned 100%. Now I know…<\/p>\n
Edit 2011-09-13:<\/strong><\/p>\n
I posted<\/a> this in the arduino.cc forum last night. As I expected, this is an issue known in the arduino community. Among other things, I was referenced to this post<\/a> discussing the issue. My problem with all of this isn’t so much that it’s odd behavior, but that it’s been odd for at least 2 years and there’s no mention of the oddness in the map() documentation. The docs are a wiki, so I proposed an addition in the forum thread, maybe I’ll get to add it and help someone out in the future.<\/p>\n","protected":false},"excerpt":{"rendered":"
The Arduino map() function is an interesting beast. Very technically it works exactly as its documented to work, but not the way almost every example uses it. Here’s an example you can find in hundreds of sketches online, including the … Continue reading →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[3,5],"tags":[8,14],"_links":{"self":[{"href":"https:\/\/www.jetmore.org\/john\/blog\/wp-json\/wp\/v2\/posts\/120"}],"collection":[{"href":"https:\/\/www.jetmore.org\/john\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.jetmore.org\/john\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.jetmore.org\/john\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.jetmore.org\/john\/blog\/wp-json\/wp\/v2\/comments?post=120"}],"version-history":[{"count":3,"href":"https:\/\/www.jetmore.org\/john\/blog\/wp-json\/wp\/v2\/posts\/120\/revisions"}],"predecessor-version":[{"id":688,"href":"https:\/\/www.jetmore.org\/john\/blog\/wp-json\/wp\/v2\/posts\/120\/revisions\/688"}],"wp:attachment":[{"href":"https:\/\/www.jetmore.org\/john\/blog\/wp-json\/wp\/v2\/media?parent=120"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.jetmore.org\/john\/blog\/wp-json\/wp\/v2\/categories?post=120"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.jetmore.org\/john\/blog\/wp-json\/wp\/v2\/tags?post=120"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}