Local functions in MATLAB

Introduction

Local functions help you organize your code by keeping small helper functions inside a main file. This keeps related code together and easy to manage.

When you want to break a big task into smaller steps inside one file.

When you want to reuse a small piece of code only within one main function.

When you want to keep your main script or function clean and readable.

When you want to avoid cluttering the workspace with many separate function files.

Syntax

MATLAB

function mainFunction()
    % main code here
end

function output = localFunction(input)
    % helper code here
end

Local functions are placed after the main function or script in the same file.

They can only be called from within the main function or other local functions in the same file.

Examples

This example shows a main function greet that calls a local function sayHello to create a greeting message.

MATLAB

function greet()
    message = sayHello('Alice');
    disp(message);
end

function msg = sayHello(name)
    msg = ['Hello, ' name '!'];
end

This example uses two local functions add and square inside the main function addAndSquare to perform calculations step-by-step.

MATLAB

function result = addAndSquare(a, b)
    sumVal = add(a, b);
    result = square(sumVal);
end

function s = add(x, y)
    s = x + y;
end

function sq = square(n)
    sq = n^2;
end

Sample Program

This program defines a main function main that uses a local function multiplyAndAdd. This local function calls two other local functions multiply and addFive to calculate the final result.

MATLAB

function main()
    x = 5;
    y = 3;
    result = multiplyAndAdd(x, y);
    fprintf('Result is %d\n', result);
end

function output = multiplyAndAdd(a, b)
    product = multiply(a, b);
    output = addFive(product);
end

function p = multiply(x, y)
    p = x * y;
end

function r = addFive(num)
    r = num + 5;
end

Important Notes

Local functions cannot be called from outside their file.

They help keep your code organized and avoid creating many separate files.

Summary

Local functions live inside the same file as the main function or script.

They help break down tasks into smaller, reusable pieces.

They keep your workspace clean by not creating extra function files.

Practice

1. What is a key characteristic of a local function in MATLAB?

easy

A. It automatically runs when MATLAB starts.

B. It must be saved in a separate file with the same name.

C. It can only be called from the command window.

D. It is defined inside the same file as the main function or script.

Solution

1. Step 1: Understand local function placement

   Local functions are defined inside the same file as the main function or script, not separately.

2. Step 2: Compare with other options

   Options A, B, and C describe behaviors that do not match local functions in MATLAB.

3. Final Answer:

   It is defined inside the same file as the main function or script. -> Option D

4. Quick Check:

   Local function location = same file [OK]

Hint: Local functions live inside the main file, not separate files. [OK]

Common Mistakes:

• Thinking local functions need separate files
• Believing local functions run automatically
• Assuming local functions can only be called from command window

2. Which of the following is the correct way to define a local function inside a MATLAB script file?

easy

A. def localFunc(x):
return x^2

B. localFunc(x) = x^2;

C. function y = localFunc(x)
y = x^2;
end

D. function y = localFunc(x)
y = x^2;

Solution

1. Step 1: Identify MATLAB function syntax

   MATLAB local functions start with the keyword function, followed by output, name, and input, and end with end.

2. Step 2: Check each option

   function y = localFunc(x) y = x^2; end uses correct MATLAB syntax with function and end. def localFunc(x): return x^2 is Python syntax. localFunc(x) = x^2; is invalid MATLAB syntax. function y = localFunc(x) y = x^2; misses the end keyword.

3. Final Answer:

   function y = localFunc(x) y = x^2; end -> Option C

4. Quick Check:

   MATLAB function syntax = function y = localFunc(x) y = x^2; end [OK]

Hint: MATLAB functions need 'function' and 'end' keywords. [OK]

Common Mistakes:

• Omitting the 'end' keyword
• Using Python or other language syntax
• Trying to assign function like a variable

3. Consider this MATLAB code in a file named mainFile.m:

function result = mainFile(x)
  result = squarePlusOne(x);

  function y = squarePlusOne(n)
    y = n^2 + 1;
  end
end

What is the return value of mainFile(3)?

medium

A. 10

B. 9

C. 7

D. Error: undefined function

Solution

1. Step 1: Understand the local function call

   The main function calls squarePlusOne(3). The local function computes 3^2 + 1 = 9 + 1 = 10.

2. Step 2: Confirm output assignment

   The result from the local function is assigned to result, which is returned by mainFile. So mainFile(3) returns 10.

3. Final Answer:

   10 -> Option A

4. Quick Check:

   3 squared plus 1 = 10 [OK]

Hint: Calculate local function output then return it. [OK]

Common Mistakes:

• Forgetting to add 1 after squaring
• Thinking local functions are inaccessible
• Confusing variable names

4. This MATLAB script contains a local function:

function output = calc(x)
  output = doubleValue(x);

  function y = doubleValue(n)
    y = n * 2
  end

result = calc(5);

What is the error in this code?

medium

A. Missing semicolon after y = n * 2 in local function

B. Missing end keyword for the main function calc

C. Local function doubleValue is not accessible inside calc

D. Local functions cannot return values

Solution

1. Step 1: Check function endings

   The local function doubleValue has an end, but the main function calc does not have its own end keyword.

2. Step 2: Verify MATLAB syntax rules

   Each function in MATLAB must end with end. Missing end for calc causes a syntax error.

3. Final Answer:

   Missing end keyword for the main function calc -> Option B

4. Quick Check:

   Every function needs 'end' [OK]

Hint: Count 'end' keywords: one per function needed. [OK]

Common Mistakes:

• Assuming semicolon omission causes error
• Thinking local functions are inaccessible
• Believing local functions can't return values

5. You want to write a MATLAB function that computes the factorial of a number using a local helper function to multiply numbers recursively. Which of the following code snippets correctly uses a local function for this purpose?

hard

A. function f = factorialMain(n)
f = helper(n);
function val = helper(k)
if k <= 1
val = 1;
else
val = k * helper(k-1);
end
end
end

B. function f = factorialMain(n)
f = helper(n);
end
function val = helper(k)
if k <= 1
val = 1;
else
val = k * helper(k-1);
end

C. function f = factorialMain(n)
f = factorial(n);
function val = helper(k)
val = k * helper(k-1);
end
end

D. function f = factorialMain(n)
f = n * factorialMain(n-1);
end

Solution

1. Step 1: Identify correct local function usage

   function f = factorialMain(n) f = helper(n); function val = helper(k) if k <= 1 val = 1; else val = k * helper(k-1); end end end defines the local function helper inside factorialMain and uses recursion properly with base case.

2. Step 2: Check other options for errors

   function f = factorialMain(n) f = helper(n); end function val = helper(k) if k <= 1 val = 1; else val = k * helper(k-1); end defines helper outside main function (not local). function f = factorialMain(n) f = factorial(n); function val = helper(k) val = k * helper(k-1); end end calls factorial (built-in) and has incomplete helper. function f = factorialMain(n) f = n * factorialMain(n-1); end is a recursive main function but lacks base case and local function.

3. Final Answer:

   function f = factorialMain(n) f = helper(n); function val = helper(k) if k <= 1 val = 1; else val = k * helper(k-1); end end end -> Option A

4. Quick Check:

   Local recursive helper inside main function = function f = factorialMain(n) f = helper(n); function val = helper(k) if k <= 1 val = 1; else val = k * helper(k-1); end end end [OK]

Hint: Local functions go inside main function with 'function' and 'end'. [OK]

Common Mistakes:

• Defining helper function outside main function
• Missing base case in recursion
• Calling built-in factorial instead of local helper