{"id":5868,"date":"2015-02-27T09:00:15","date_gmt":"2015-02-27T14:00:15","guid":{"rendered":"https:\/\/blogs.mathworks.com\/pick\/?p=5868"},"modified":"2015-02-27T09:12:57","modified_gmt":"2015-02-27T14:12:57","slug":"for-each","status":"publish","type":"post","link":"https:\/\/blogs.mathworks.com\/pick\/2015\/02\/27\/for-each\/","title":{"rendered":"For Each"},"content":{"rendered":"
\n \n

Sean<\/a>'s pick this week is For-Each<\/a> by Jeremy Hughes<\/a>.\n <\/p>\n <\/introduction>\n

My pick this week is a toolbox from our development organization for a for-each loop<\/a> construct in MATLAB. A for-each loop allows you to iterate over a set or dimension without having to worry about indexing.\n <\/p>\n

MATLAB actually already has this built in for single elements of numeric arrays:<\/p>

% Display each element in x<\/span>\nfor<\/span> thisfile = [1 pi 8 -3]\n    disp(thisfile)\nend<\/span><\/pre>
     1\n    3.1416\n     8\n    -3\n<\/pre>
This could've course been written with an index like below.<\/p>
% Display each element in x with an index<\/span>\nthisfile = [1 pi 8 -3];\nfor<\/span> ii = 1:numel(thisfile)\n    disp(thisfile(ii))\nend<\/span><\/pre>
     1\n    3.1416\n     8\n    -3\n<\/pre>
But what if we want to traverse every column or slice of a three dimensional array?  Or each element in a cell array?  Or\n      each combination of two arrays?  This is where Jeremy's for-each<\/tt> construct comes in handy since you won't need to worry about indexing.\n   <\/p>\n   
Let's take a bunch of csv files and make copies of them with just the rows of data we care about.  These files contain energy\n      outage information for energy outages in America.   Being from New England, I just want the records that correspond to the\n      North East.\n   <\/p>\n   
 <\/p>
% Scrape the data directory for all csv files<\/span>\ndatadir = '.\\Data\\'<\/span>;\nfiles = dir([datadir '*.csv'<\/span>]);\nfilenames = {files.name};\ndisp(filenames)<\/pre>
  Columns 1 through 4\n    '2002Data.csv'    '2003Data.csv'    '2004Data.csv'    '2005Data.csv'\n  Columns 5 through 8\n    '2006Data.csv'    '2007Data.csv'    '2008Data.csv'    '2009Data.csv'\n  Columns 9 through 12\n    '2010Data.csv'    '2011Data.csv'    '2012Data.csv'    '2013Data.csv'\n<\/pre>
%  Make a directory for output<\/span>\noutputdir = 'NorthEastData'<\/span>;\nmkdir(outputdir)\n\n% Loop over each filename, read, extract, write<\/span>\nfor<\/span> thisfile = each(filenames)\n    % Reach each file<\/span>\n    Temp = readtable([datadir thisfile]);\n    Temp.Region = categorical(Temp.Region); % Convert to categorical<\/span>\n\n    % Identify and extract the northeast records<\/span>\n    northeast = Temp.Region == 'NorthEast'<\/span>;\n    Output = Temp(northeast,:);\n\n\n    % Make new full file name<\/span>\n    [~,name,ext] = fileparts(thisfile);\n    outputfile = fullfile(pwd,outputdir,[name '_NorthEast'<\/span> ext]);\n\n    % Write out<\/span>\n    writetable(Output,outputfile)\nend<\/span><\/pre>
Now we can check to make sure it did what we expect.<\/p>\n   
 <\/p>\n   
Personally, I see this being really useful for working with sets of files or images, like I have done above, or for needle\n      in the haystack type problems where I want to find something in a bunch of combinations and stop as soon as I do.\n   <\/p>\n   
Advanced Programming Challenge!<\/a><\/h3>\n   
And now for a challenge:<\/p>\n   
I used the informal interface to this toolbox, i.e. the each<\/tt> function, to traverse each file.  There is also a formal interface that provides the ability to define your own iterators<\/a> so that you can traverse objects of your own class or anything else.  I will give some MathWorks goodies to anyone who will\n      write their own eachFile<\/tt> iterator that I could use above to recreate what I have.\n   <\/p>\n   
Please post it below<\/a>.\n   <\/p>\n   
Comments<\/a><\/h3>\n   
The development team is actively looking for feedback on this, so please leave them a comment<\/a> with any thoughts you have.\n   <\/p>\n   
Give it a try and let us know what you think here<\/a>.\n   <\/p>