Products & Services Solutions Academia Support User Community Company

Learn more about MATLAB   

Debugging Process and Features

On this page…

Ways to Debug M-Files

Preparing for Debugging

Setting Breakpoints

Running an M-File with Breakpoints

Stepping Through an M-File

Examining Values

Correcting Problems and Ending Debugging

Conditional Breakpoints

Breakpoints in Anonymous Functions

Breakpoints in Methods that Overload Functions

Error Breakpoints

Debugging Functions

Ways to Debug M-Files

You can debug the M-files using the Editor, which is a graphical user interface, as well as by using debugging functions from the Command Window. You can use both methods interchangeably. These topics and the example describe both methods.

Back to Top

Preparing for Debugging

Do the following to prepare for debugging:

Debugging Example — The Collatz Problem

The debugging process and features are best described using an example. To prepare to use the example, create two M-files, collatz.m and collatzplot.m, that produce data for the Collatz problem.

For any given positive integer, n, the Collatz function produces a sequence of numbers that always resolves to 1. If n is even, divide it by 2 to get the next integer in the sequence. If n is odd, multiply it by 3 and add 1 to get the next integer in the sequence. Repeat the steps until the next integer is 1. The number of integers in the sequence varies, depending on the starting value, n.

The Collatz problem is to prove that the Collatz function will resolve to 1 for all positive integers. The M-files for this example are useful for studying the Collatz problem. The file collatz.m generates the sequence of integers for any given n. The file collatzplot.m calculates the number of integers in the sequence for all integers from 1 through m, and plots the results. The plot shows patterns that can be further studied.

Following are the results when n is 1, 2, or 3.

n

Sequence

Number of Integers in the Sequence

1

1

1

2

2  1

2

3

3  10  5  16  8  4  2  1

8

M-Files for the Collatz Problem.   Following are the two M-files you use for the debugging example. To create these files on your system, open two new M-files. Select and copy the following code from the Help browser and paste it into the M-files. Save and name the files collatz.m and collatzplot.m. Save them to your current folder or add the folder where you save them to the search path. One of the files has an embedded error to illustrate the debugging features.

Code for collatz.m.

function sequence=collatz(n)
% Collatz problem. Generate a sequence of integers resolving to 1
% For any positive integer, n:
% 	Divide n by 2 if n is even
% 	Multiply n by 3 and add 1 if n is odd
% 	Repeat for the result
% 	Continue until the result is 1

sequence = n;
next_value = n;
while next_value > 1
	if rem(next_value,2)==0
		next_value = next_value/2;
	else
		next_value = 3*next_value+1;
	end
	sequence = [sequence, next_value];
end

Code for collatzplot.m.

function collatzplot(m)
% Plot length of sequence for Collatz problem
% Prepare figure
clf
set(gca,'XScale','linear')
%
% Determine and plot sequence and sequence length
for N = 1:m
	plot_seq = collatz(N);
	seq_length(N) = length(plot_seq);
	line(N,plot_seq,'Marker','.','MarkerSize',9,'Color','blue')
	drawnow
end

Alternatively, you can open the files by issuing the following commands, and then save each file to a local folder:

open(fullfile(matlabroot,'help','techdoc','matlab_env',...
	'examples','collatz.m'))

open(fullfile(matlabroot,'help','techdoc','matlab_env',...
	'examples','collatzplot.m'))

Trial Run for Example.   Open the file collatzplot.m. Make sure the current folder is the folder in which you saved collatzplot.

Try out collatzplot to see if it works correctly. Use a simple input value, for example, 3, and compare the results to those shown in the preceding table. Typing

collatzplot(3)

produces the plot shown in the following figure.

Image of plot. There is one point at x = 1, two points at x = 2, and 8 points at x = 3.

The plot for n = 1 appears to be correct—for 1, the Collatz series is 1, and contains one integer. But for n = 2 and n = 3, it is wrong because there should be only one value plotted for each integer, the number of integers in the sequence, which the preceding table shows to be 2 (for n = 2) and 8 (for n = 3). Instead, multiple values are plotted. Use MATLAB debugging features to isolate the problem.

Back to Top

Setting Breakpoints

Set breakpoints to pause execution of the M-file so you can examine values where you think the problem can be. You can set breakpoints in the Editor, using functions in the Command Window, or both.

There are three basic types of breakpoints you can set in M-files:

You can disable standard and conditional breakpoints so that MATLAB temporarily ignores them, or you can remove them. For details, see Disabling and Clearing Breakpoints. Breakpoints are not maintained after you exit the MATLAB session.

You can only set valid standard and conditional breakpoints at executable lines in saved files that are in the current folder or in folders on the search path. When you add or remove a breakpoint in a file that is not in a folder on the search path or in the current folder, a dialog box appears. This dialog box presents options that allow you to add or remove the breakpoint. You can either change the current folder to the folder containing the file, or you can add the folder containing the file to the search path.

Do not set a breakpoint at a for statement if you want to examine values at increments in the loop. For example, in

for n = 1:10 
    m = n+1; 
end

MATLAB executes the for statement only once, which is efficient. Therefore, when you set a breakpoint at the for statement and step through the file, you only stop at the for statement once. Instead place the breakpoint at the next line, m=n+1 to stop at each pass through the loop.

You cannot set breakpoints while MATLAB is busy, for example, running an M-file, unless that M-file is paused at a breakpoint.

Setting Standard Breakpoints

To set a standard breakpoint using the Editor:

  1. If you have changed the file, save it.

  2. Click in the breakpoint alley at an executable line where you want to set the breakpoint.

    • The breakpoint alley is the narrow column on the left side of the Editor, to the right of the line number.

    • Executable lines are preceded by a - (dash).

      If you attempt to set breakpoints at lines that are not executable, such as comments or blank lines, MATLAB sets it at the next executable line.

Other ways to set a breakpoint are to:

Setting Breakpoints for the Example.   It is unclear whether the problem in the example is in collatzplot or collatz. To start, follow these steps:

  1. Set a breakpoint in collatzplot.m at line 9.

    This breakpoint enables you to step into collatz to see if the problem is there.

  2. Set additional breakpoints at lines 10 and 11.

    These breakpoints stop the program so you can examine the interim results.

Image of collatzplot.m in Editor showing breakpoints at lines 9, 10, and 11. Click a dash in the breakpoint alley to set a breakpoint at that line.

Understanding Valid (Red) and Invalid (Gray) Breakpoints.   Red breakpoints indicate valid standard breakpoints. If breakpoints are gray, they are not valid.

Image of invalid breakpoints (gray) in Editor. In this example, the breakpoints are invalid because changes to the file have not been saved. When you save the file, the breakpoints become valid and turn from gray to red.

Breakpoints are gray for either of these reasons:

Function Alternative for Setting Breakpoints

To set a breakpoint using the debugging functions, use dbstop. For the example, type:

dbstop in collatzplot at 9
dbstop in collatzplot at 10
dbstop in collatzplot at 11

Back to Top

Running an M-File with Breakpoints

After setting breakpoints, run the M-file from the Command Window or the Editor.

Running the Example

For the example, run collatzplot for the simple input value, 3, by typing in the Command Window

collatzplot(3)

The example, collatzplot, requires an input argument and therefore runs only from the Command Window or from a run configuration with a value specified.

Results of Running an M-File Containing Breakpoints

Running the M-file results in the following:

In debug mode, you can set breakpoints, step through programs, examine variables, and run other functions.

Note that MATLAB software could become nonresponsive if it stops at a breakpoint while displaying a modal dialog box or figure that your M-file creates. In that event, use Ctrl+C to go the MATLAB prompt.

Back to Top

Stepping Through an M-File

While debugging, you can step through an M-file, pausing at points where you want to examine values.

Use the step buttons or the step items in the Debug menu of the Editor or desktop, or use the equivalent functions.

Toolbar Button

Debug Menu Item

Description

Function Alternative

Run M-file configuration button

Run m-file or Run Configuration for m-file

Commence execution of M-file and run until completion or until a breakpoint is encountered. The Run Configurations for m-file menu item provides a submenu that enables you to select a particular run configuration or to edit the run configurations for the M-file. If you choose Run m-file, MATLAB uses the default run configuration.

None

None

Go Until Cursor

Continue execution of M-file until the line where the cursor is positioned. Also available on the context menu.

None

Step button

Step

Execute the current line of the M-file.

dbstep

Step in button

Step In

Execute the current line of the M-file and, if the line is a call to another function, step into that function.

dbstep in

Continue button

ContinueResume execution of M-file until completion or until another breakpoint is encountered.

dbcont

Step out button

Step Out

After stepping in, run the rest of the called function or subfunction, leave the called function, and pause.

dbstep out

Continue Running in the Example

In the example, collatzplot is paused at line 9. Because the problem results are correct for N/n = 1, continue running until N/n = 2. Press the Continue button Image of the Continue button. three times to move through the breakpoints at lines 9, 10, and 11. Now the program is again paused at the breakpoint at line 9.

Stepping In to Called Function in the Example

Now that collatzplot is paused at line 9 during the second iteration, use the Step In button or type dbstep in in the Command Window to step into collatz and walk through that M-file. Stepping into line 9 of collatzplot goes to line 9 of collatz. If collatz is not open in the Editor, it automatically opens if you have selected Debug > Open Files When Debugging.

The pause indicator at line 9 of collatzplot changes to a hollow arrow , indicating that MATLAB control is now in a subfunction called from the main program. The call stack shows that the current function is now collatz.

In the called function, collatz in the example, you can do the same things you can do in the main (calling) function—set breakpoints, run, step through, and examine values.

Back to Top

Examining Values

While the program is paused, you can view the value of any variable currently in the workspace. Examine values when you want to see whether a line of code has produced the expected result or not. If the result is as expected, continue running or step to the next line. If the result is not as expected, then that line, or a previous line, contains an error. Use the following methods to examine values:

Many of these methods are used in Examining Values in the Example.

Selecting the Workspace

Variables assigned through the Command Window and created using scripts are considered to be in the base workspace. Variables created in a function belong to their own function workspace. To examine a variable, you must first select its workspace. When you run a program, the current workspace is shown in the Stack field. To examine values that are part of another workspace for a currently running function or for the base workspace, first select that workspace from the list in the Stack field.

If you use debugging functions from the Command Window:

Workspace in the Example.   At line 9 of collatzplot, you stepped in, and the current line is 9 in collatz. The Stack shows that collatz is the current workspace.

Viewing Values as Data Tips in the Editor

In the Editor, position the mouse pointer to the left of a variable. Its current value appears—this is called a data tip, which is like a Tooltip for data. The data tip stays in view until you move the pointer. If you have trouble getting the data tip to appear, click in the line containing the variable and then move the pointer next to the variable.

A related function is datatipinfo.

Data Tips in the Example.   Position the mouse pointer over n in line 9 of collatz. The data tip shows that n = 2, as expected.

Image of collatz.m file in the Editor, showing data tip. The mouse pointer is positioned at line 9, sequence = n, at the n. A data tip shows the value of n, n: 1 x 1 double = 2.

Viewing Values in the Command Window

You can examine values while in debug mode at the K>> prompt. To see the variables currently in the workspace, use who. Type a variable name in the Command Window and it displays the variable's current value. For the example, to see the value of n, type

n

The Command Window displays the expected result

n =
	2

and displays the debug prompt, K>>.

Viewing Values in the Workspace Browser and Variable Editor

You can view the value of variables in the Value column of the Workspace browser. The Workspace browser displays all variables in the current workspace. Use the Stack in the Workspace browser to change to another workspace and view its variables.

Image of Workspace browser showing the variable n and its value and class.

The Value column does not show all details for all variables. To see details, double-click a variable in the Workspace browser. The Variable Editor opens, displaying the content for that variable. You can open the Variable Editor directly for a variable using openvar.

To see the value of n in the Variable Editor for the example, type

openvar n

and the Variable Editor opens, showing that n = 2 as expected.

Image of Variable Editor showing n.

Evaluating a Selection

Select a variable or equation in an M-file in the Editor. Right-click and select Evaluate Selection from the context menu (for a single-button mouse, use Ctrl+ click). The Command Window displays the value of the variable or equation. You cannot evaluate a selection while MATLAB is busy, for example, running an M-file.

Examining Values in the Example

Step from line 9 through line 13 in collatz. Step again, and the pause indicator jumps to line 17, just after the if loop, as expected. Step again, to line 18, check the value of sequence in line 17 and see that the array is

2  1

as expected for n = 2. Step again, which moves the pause indicator from line 18 to line 11. At line 11, step again. Because next_value is now 1, the while loop ends. The pause indicator is at line 11 and appears as a green down arrow . This indicates that processing in the called function is complete and program control will return to the calling program. Step again from line 11 in collatz and execution is now paused at line 9 in collatzplot.

Note that instead of stepping through collatz, the called function, as was just done in this example, you can step out from a called function back to the calling function, which automatically runs the rest of the called function and returns to the next line in the calling function. To step out, use the Step Out button or type dbstep out in the Command Window.

In collatzplot, step again to advance to line 10, and then line 11. The variable seq_length in line 10 is a vector with the elements:

1  2

which is correct.

Finally, step again to advance to line 12. Examining the values in line 11, N  = 2 as expected, but the second variable, plot_seq, has two values, where only one value is expected. While the value for plot_seq is as expected:

2  1

it is the incorrect variable for plotting. Instead, seq_length(N) should be plotted.

Problems Viewing Variable Values from Parent Workspace

Sometimes, if you set a breakpoint in a function, and then attempt to view the value of a variable in the parent workspace using the dbup command, the value of the variable is currently under construction. Therefore, the value is not available. This is true whether you view the value by specifying the dbup command in the Command Window or by using the Stack field on the Editor toolbar.

In such cases, MATLAB returns the following message, where x is the variable for which you are trying to examine the value:

K>> x
??? Reference to a called function result under construction x.

For example, suppose you have code such as the following:

x = collatz(x);

MATLAB detects that the evaluation of collatz(x) replaces the input variable, x. To optimize memory use, MATLAB overwrites the memory that x currently occupies to hold a new value for x. When you request the value of x, and it is under construction, its value is not available, and MATLAB displays the error message.

Back to Top

Correcting Problems and Ending Debugging

These are some of the ways to correct problems and end the debugging session:

Many of these features are used in Completing the Example.

Changing Values and Checking Results

While debugging, you can change the value of a variable in the current workspace to see if the new value produces expected results. While the program is paused, assign a new value to the variable in the Command Window, Workspace browser, or Variable Editor. Then continue running or stepping through the program. If the new value does not produce the expected results, the program has a different problem.

Ending Debugging

After identifying a problem, end the debugging session. You must end a debugging session if you want to change and save an M-file to correct a problem, or if you want to run other functions in MATLAB.

To end debugging, click the Exit debug mode button , or select Exit Debug Mode from the Debug menu.

You can instead use the function dbquit or the Shift+F5 keyboard shortcut to end debugging.

After quitting debugging, pause indicators in the Editor display no longer appear, and the normal prompt >> appears in the Command Window instead of the debugging prompt, K>>. You can no longer access the call stack.

Disabling and Clearing Breakpoints

Disable a breakpoint to temporarily ignore it. Clear a breakpoint to remove it.

Disabling and Enabling Breakpoints.   You can disable selected breakpoints so the program temporarily ignores them and runs uninterrupted, for example, after you think you identified and corrected a problem. This is especially useful for conditional breakpoints—see Conditional Breakpoints.

To disable a breakpoint, right-click the breakpoint icon and select Disable Breakpoint from the context menu, or click anywhere in a line and select Enable/Disable Breakpoint from the Debug or context menu. You can also disable a conditional breakpoint by clicking the breakpoint icon. This puts an X through the breakpoint icon as shown here.

Image of disabled breakpoint at line 10.

When you run dbstatus, the resulting message for a disabled breakpoint is

Breakpoint on line 9 has conditional expression 'false'.

After disabling a breakpoint, you can enable it to make it active again, or clear it. To enable it, right-click the breakpoint icon and select Enable Breakpoint from the context menu, or click anywhere in a line and select Enable/Disable Breakpoint from the Breakpoints or context menu. The X no longer appears on the breakpoint icon and program execution will pause at that line.

Clearing (Removing) Breakpoints.   All breakpoints remain in a file until you clear (remove) them or until they are automatically cleared. Clear a breakpoint after determining that a line of code is not causing a problem.

To clear a breakpoint in the Editor:

To clear all breakpoints in all files:

Breakpoints are automatically cleared when you

Saving Breakpoints

You can use the s=dbstatus syntax and then save s to save the current breakpoints to a MAT-file. At a later time, you can load s and restore the breakpoints using dbstop(s). For more information, including an example, see the dbstatus reference page.

Correcting an M-File

To correct a problem in an M-file,

  1. Quit debugging.

    Do not make changes to an M-file while MATLAB is in debug mode. If you do edit an M-file while in debug mode, breakpoints turn gray, indicating that results might not be reliable. See Understanding Valid (Red) and Invalid (Gray) Breakpoints for details.

  2. Make changes to the M-file.

  3. Save the M-file.

  4. Set, disable, or clear breakpoints, as appropriate.

  5. Run the M-file again to be sure it produces the expected results.

Completing the Example

To correct the problem in the example, do the following:

  1. End the debugging session. One way to do this is to select Exit Debug Mode from the Debug menu.

  2. In collatzplot.m line 11, change the string plot_seq to seq_length(N) and save the file.

  3. Clear the breakpoints in collatzplot.m. One way to do this is by typing

    dbclear all in collatzplot

    in the Command Window.

  4. Run collatzplot for m = 3 by typing

    collatzplot(3)

    in the Command Window.

  5. Verify the result. The figure shows that the length of the Collatz series is 1 when n = 1, 2 when n = 2, and 8 when n = 3, as expected.

    Image of plot. There is one point at 1,1, one point at 2,2, and one point at 3,8.

  6. Test the function for a slightly larger value of m, such as 6, to be sure the results are still accurate. To make it easier to verify collatzplot for m = 6 as well as the results for collatz, add this line at the end of collatz.m

    sequence

    which displays the series in the Command Window. The results for when n = 6 are

    sequence =

     6     3    10     5    16     8     4     2     1

    Then run collatzplot for m = 6 by typing

    collatzplot(6)

  7. To make debugging easier, you ran collatzplot for a small value of m. Now that you know it works correctly, run collatzplot for a larger value to produce more interesting results. Before doing so, you might want to disable output for the line you just added in step 6, line 19 of collatz.m, by adding a semicolon to the end of the line so it appears as

    sequence;

    Then run

    collatzplot(500)

    The following figure shows the lengths of the Collatz series for n = 1 through n = 500.

    Image of plot showing 500 points.

Running Sections in M-Files That Have Unsaved Changes

It is a good practice to make changes to an M-file after you quit debugging, and to save the changes and then run the file. Otherwise, you might get unexpected results. But there are situations where you might want to experiment during debugging, to make a change to a part of the file that has not yet run, and then run the remainder of the file without saving the change.

To do this, while stopped at a breakpoint, make a change to a part of the file that has not yet run. Breakpoints will turn gray, indicating they are invalid. Then select all of the code after the breakpoint, right-click, and choose Evaluate Selection from the context menu. You can also use cell mode to do this.

Back to Top

Conditional Breakpoints

Set conditional breakpoints to cause MATLAB to stop at a specified line in a file only when the specified condition is met. One particularly good use for conditional breakpoints is when you want to examine results after a certain number of iterations in a loop. For example, set a breakpoint at line 10 in collatzplot, specifying that MATLAB should stop only if N is greater than or equal to 2. This section covers the following topics:

Setting Conditional Breakpoints

To set a conditional breakpoint, follow these steps:

  1. Click in the line where you want to set the conditional breakpoint. Then select Set/Modify Conditional Breakpoint from the Debug or context menu. If a standard breakpoint already exists at that line, use this same method to make it conditional.

    The MATLAB Editor conditional breakpoint dialog box opens as shown in this example.

    Image of conditional breakpoint dialog box.

  2. Type a condition in the dialog box, where a condition is any legal MATLAB expression that returns a logical scalar value. Click OK. As noted in the dialog box, the condition is evaluated before running the line. For the example, at line 9 in collatzplot, enter

    N>=2

    as the condition. A yellow breakpoint icon (indicating the breakpoint is conditional) appears in the breakpoint alley at that line.

Image of line with conditional breakpoint.

When you run the file, MATLAB software enters debug mode and pauses at the line only when the condition is met. In the collatzplot example, MATLAB runs through the for loop once and pauses on the second iteration at line 9 when N is 2. If you continue executing, MATLAB pauses again at line 9 on the third iteration when N is 3.

Copying, Modifying, Disabling, and Clearing Conditional Breakpoints

To copy a conditional breakpoint, right-click the icon in the breakpoint alley and select Copy from the context menu. Then right-click in the breakpoint alley at the line where you want to paste the conditional breakpoint and select Paste from the context menu.

Modify the condition for the breakpoint in the current line by selecting Set/Modify Conditional Breakpoint from the Debug or context menu.

Click a conditional breakpoint icon to disable it. Click a disabled conditional breakpoint to clear it.

Function Alternative for Conditional Breakpoints

Use the dbstop function with appropriate arguments to set conditional breakpoints from the Command Window, and use dbclear to clear them. Use dbstatus to view the breakpoints currently set, including any conditions, which are listed in the expression field. If no condition exists, the value in the expression field is [  ] (empty). For details, see the function reference pages: dbstop, dbclear, and dbstatus.

Back to Top

Breakpoints in Anonymous Functions

There can be multiple breakpoints in an M-file line that contains anonymous functions. There can be a breakpoint for the line itself (MATLAB software stops at the start of the line), as well as a breakpoint for each anonymous function in that line. When you add a breakpoint to a line containing an anonymous function, the Editor asks exactly where in the line you want to add the breakpoint. If there is more than one breakpoint in a line, the breakpoint icon is blue .

When there are multiple breakpoints set on a line, the icon is always blue, regardless of the status of any of the breakpoints on the line. Position the mouse on the icon and a Tooltip displays information about all breakpoints in that line.

To perform a breakpoint action for a line that can contain multiple breakpoints, such as Clear Breakpoint, right-click the breakpoint alley at that line and select the action. MATLAB prompts you to specify the exact breakpoint on which to act in that line.

When you set a breakpoint in an anonymous function, MATLAB stops when the anonymous function is called. The following illustration shows the Editor when you set a breakpoint in the anonymous function sqr in line 2, and then run the file. MATLAB stops when it runs sqr in line 4. After you continue execution, MATLAB stops again when it runs sqr the second time in line 4. Note that the Stack display shows the anonymous function.

Image of Editor showing debugging for anonymous functions in a file.

Back to Top

Breakpoints in Methods that Overload Functions

MATLAB functions often call other MATLAB functions and methods to perform their operations. If you set a breakpoint in a class method, and then run a MATLAB function that results in calling that method, execution stops at the breakpoint. This behavior can be confusing if you are unaware that the MATLAB function calls the method containing the breakpoint.

For instance, suppose you do the following:

  1. Define a class named MyClass that overloads the MATLAB size function.

  2. Create an instance of MyClass.

  3. Insert breakpoints within the MyClass size method.

  4. Call whos.

When you call the whos function, it calls the size function to obtain size information about the variables in the workspace. Under the preceding circumstances, because MyClass overloads the size function, whos calls the MyClass size method instead of the default size function to determine the size of the MyClass object. Execution stops at the breakpoint you set in the size method. You can enable the MATLAB function to execute to completion by either stepping or continuing through the method. To prevent this behavior from recurring, remove the breakpoints.

Back to Top

Error Breakpoints

Set error breakpoints to stop program execution and enter debug mode when MATLAB encounters a problem. Unlike standard and conditional breakpoints, you do not set these breakpoints at a specific line in a specific file. Rather, once set, MATLAB stops at any line in any file when the error condition specified by using the error breakpoint occurs. MATLAB then enters debug mode and opens the file containing the error, with the pause indicator at the line containing the error. Files open only when you select Debug > Open Files when Debugging. Error breakpoints remain in effect until you clear them or until you end the MATLAB session. You can set error breakpoints from the Debug menu in any desktop tool. This section covers the following topics:

Setting and Clearing Error Breakpoints

To set error breakpoints:

  1. Select Debug > Stop if Errors/Warnings.

  2. In the Stop if Errors/Warnings for All Files dialog box, specify error breakpoints on all appropriate tabs, and then click OK.

To clear error breakpoints, select the Never stop if ... option for all appropriate tabs, and then click OK.

Image of Error/Warning Breakpoint dialog box.

Error Breakpoint Types and Options

As the tabs in the Stop if Errors/Warnings for All Files dialog box suggest, there are four basic types of error breakpoints you can set:

Select options for these error breakpoints, as follows:

Examples of Setting Warning and Error Breakpoints

Pausing Executing for Warnings.   To pause execution when MATLAB produces a warning:

  1. Select the Warnings tab.

  2. Select Always stop if warning, and then click OK.

Now, when you run an M-file and MATLAB produces a warning, execution pauses andMATLAB enters debug mode. The file opens in the Editor at the line that produced the warning.

Setting Breakpoints for a Specific Error.   To stop execution for a specific error add a message identifier:

  1. Select the Errors, Try/Catch Errors, or Warnings tab.

  2. Select the Use Message Identifiers option.

  3. Click Add.

  4. In the resulting Add Message Identifier dialog box, type the message identifier of the error for which you want to stop. The identifier is of the form component:message (for example, MATLAB:nargchk:notEnoughInputs). Then click OK.

    The message identifier you specified appears in the Stop If Errors/Warnings for All Files dialog box.

  5. Click OK.

Obtaining Error Message Identifiers.   To obtain an error message identifier generated by a MATLAB function, run the function to produce the error, and then call MExeption.last. For example:

surf
MException.last

The Command Window displays the MException object, including the error message identifier in the identifier field. For this example, it displays: 

ans = 

  MException

  Properties:
    identifier: 'MATLAB:nargchk:notEnoughInputs'
       message: 'Not enough input arguments.'
         cause: {}
         stack: [1x1 struct]

  Methods

Obtaining Warning Message Identifiers.   To obtain a warning message identifier generated by a MATLAB function, run the function to produce the warning. Then, run:

[m,id] = lastwarn

MATLAB returns the last warning identifier to id. An example of a warning message identifier is MATLAB:divideByZero.

Function Alternative for Error Breakpoints

The function equivalent for each option appears in the Stop if Errors/Warnings for All Files dialog box, to the right of each option. For example, the function equivalent for Always stop if error is dbstop if error. Use these functions in the command Window as follows:

Back to Top

Debugging Functions

The debug functions are:

Back to Top

  

Checking M-File Code for Problems Using the M-Lint Code AnalyzerChecking M-File Code for Problems Using the M-Lint Code Analyzer Using Cells for Rapid Code Iteration and Publishing ResultsUsing Cells for Rapid Code Iteration and Publishing Results

Recommended Products

Get MATLAB trial software

Includes the most popular MATLAB recorded presentations with Q&A sessions led by MATLAB experts.

Get the Interactive Kit

 © 1984-2009- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS