Skip to main content

Creating a Logfile for your project in Matlab

If you have a complicated project with many functions interconnected with each other, debugging could be a pain in the neck. To make it a bit more easier, I personally write "current status" of the code to a text file.

Every time a specific event is caused, I write to the text file, along with the timestamp of the message. This helps me often, to pin point the mistake in my code.

This is fairly simple thing to do. See the below function, write_log.m

function write_log(msg)

fid = fopen(fullfile(pwd, 'LogFile.txt'), 'a');
if fid == -1
  error('Cannot open log file.');
end
fprintf(fid, '%s: %s\r\n', datestr(now, 0), msg);  %this line could be changed to add more details to the message
fclose(fid);

end

pwd stands for present working directory. I want to save the LogFile in the same directory as the current project.
Every time the message, indicated by the variable msg here, is written to the text file, I precede it with the current date and time.

Lets make a few example calls to the function and see what the text file contains.

write_log('starting the project');
pause(2);  %wait 2 seconds.
write_log('No error yet');
pause(1);  %wait 1 second.
write_log('Alright, time to see the results!');

Taking a look at the LogFile, we see the following three lines:

12-Jan-2020 19:51:12: starting the project
12-Jan-2020 19:51:14: No error yet
12-Jan-2020 19:51:15: Alright, time to see the results!

Notice the timestamps and their delays from each other.
Labels:

Comments

Post a Comment

Popular posts from this blog

Checking if two arrays are equal or not in Matlab

You might already know that to see if two variables are equal or not, we could use the == operator. But what about if you want to check two arrays or two structures are similar or not? In such a case a simple == doesn't work. In such a case, the function isequal helps us to achieve this. The usage is pretty simple, as you can see in the below examples... Example 1: A = zeros(2,2)+1e-10; B = zeros(2,2); check = isequal(A,B) A and B differ by a small fraction, but still the variable check shows the value "0" after running the snippet. Example 2: A = zeros(2,2); B = zeros(3,2); check = isequal(A,B) In the above case, both the arrays A and B have zero, but their size is different. Hence the answer, check shows "0". Example 3: A = struct( 'field1' ,0.05, 'field2' ,200); B = struct( 'field2' ,200, 'field1' ,0.05); check = isequal(A,B) The structures are declared in the first two lines. You can see that, f...
Post a Comment
Read more

Making Matlab Code Faster - #1 Preallocation

This is the first post in the series of Making Matlab Code Faster series. As you might have realized already, getting stuff somehow to get to work, might be a fairly simple task with Matlab. But why stop there? Why not make the necessary changes to see if your code can perform better. There are few things you can do towards this goal. Preallocation is just one of them. Let's look at an example: a=rand(1000000,1);   %Declare a random matrix with 1 million elements b=0;  j=1; for i=1:size(a,1)   %run the loop for the all the elements in 'a'.      if (a(i) < 0.5)   %if the current element is less than 0.5 save it in an array 'b'          b(j)=a(i);         j=j+1;   %increment j to save next element in the next location in 'b'     end end We can see that initially array 'b' is single element matrix. But as time goes on, we keep ...
Post a Comment
Read more

Find Execution Time In Matlab

MATLAB (matrix laboratory) is a multi-paradigm numerical computing environment and proprietary programming language developed by MathWorks. It still amazes me how easily scientific calculations can be done with the help of this tool. Sometimes you might want to know, how fast or slow is the piece of code you have written. This is very easy with matlab. The built-in function tic and toc can be used for this.  See the example below. tic  %add this statement just before the start of the code you want to check a=rand(100);  %create 100 by 100 random matrix. for i=1:10  %repeat 10 times     a=a*a;  %matrix multiplication end toc  %add this statement just after the end of the code you want to check The code is self explanatory. Running the code in Matlab 2016b, a message similar to the following will be shown on Command Window. Elapsed time is 0.045149 seconds. Pretty simple isn't it.  :)
Post a Comment
Read more