ENGR-25 Lec-07 Sp12 Functions-3 Handles Types

Engr/Math/Physics 25
Chp3 MATLAB
Functions: Part3
Bruce Mayer, PE
Licensed Electrical & Mechanical Engineer
BMayer@ChabotCollege.edu
Engineering/Math/Physics 25: Computational Methods
1
Bruce Mayer, PE
BMayer@ChabotCollege.edu ENGR-25_Functions-3.ppt
Learning Goals
Understand the difference Built-In and User-Defined MATLAB Functions Write User Defined Functions Describe Global and Local Variables When to use SUBfunctions as opposed to NESTED-Functions Import Data from External Data-Files
As generated, for example, by an Electronic Data-Acquisition System
2
Bruce Mayer, PE
Functions (ReDeaux)
MATLAB Has Two Types of Functions 1. Built-In Functions Provided by the Softeware
e.g.; max, min, median
2. User-Defined Functions are .m-files that can accept InPut Arguments/Parameters and Return OutPut Values
3
Bruce Mayer, PE
Function Handle (MATLAB help)

MATLAB functions are written to NAMED files or are produced at the command line as ANONYMOUS functions.
In either case, a function handle is used to pass the function as an input argument to a function function.
4
Bruce Mayer, PE
Function Handles
You can create a function handle to any function by using the at sign, @, before the function name. You can then name the handle if you wish, and use the handle to reference the function. For example, to create a handle to the sine function, you type
>> sine_handle = @sin;
where sine_handle is a user-selected name for the handle (or NickName).

5
Bruce Mayer, PE
Function Handles cont

A common use of a function handle is to pass the function as an argument to another function. For example, plot sinx over 0 x 6 as follows:
>> plot([0:0.01:6], sine_handle([0:0.01:6]))
The Result

6
Bruce Mayer, PE

This is a rather cumbersome way to plot the sine function, but the concept can be extended to create, say, a general purpose plotting function that accepts a built-in function as an input. For example,
function p = gen_plot(fcn_handle, interval) plot(interval, fcn_handle(interval))
Create a handle to the natural log (ln) function

Plot over 199
7
>> ln_handle = @log; >> gen_plot(ln_handle,1:99)

Bruce Mayer, PE

Can Pass a Function with @ sign handle
>> gen_plot(@sech,0:.02:10)

8
Bruce Mayer, PE
Calling Functions
There are four ways to invoke, or call, a function into action. These are:
1. As a character string identifying the appropriate function .m-file 2. As a function handle
3. As an inline function object 4. As a string expression.
Examples of these ways follow for the fzero Built-in fcn which acts on the user-defined function parab, which computes y = x2 4
Bruce Mayer, PE

9
parab.m Graphed
25 20
15
xplt = linspace(-5,5); yplt = parab(xplt) plot(xplt,yplt) grid xlabel('x') ylabel('parab(x)')
parab(x)
10
-5 -5
10
-4
-3
-2
-1
0 x
4
Bruce Mayer, PE
Calling Functions cont

1. As a character string identifying the appropriate function .m-file, which is
The function may be called as follows, to compute the zero over the range: 0 x 3
>> [x, value] = fzero('parab', [0 3]) x = 2 value = 0

11
Bruce Mayer, PE

2. As a function handle to an existing function .m-file:
>> [z, val0] = fzero(@parab,[0, 3])
3. As an inline function object:

>> parab1 = 'x.^2-4'; >> parab_inline = inline(parab1); >> [w, val_0] = fzero(parab_inline,[0, 3]) w = 2 val_0 = 0
12
Bruce Mayer, PE

4. As a string expression:
>> parab2 = 'x.^2-4'; >> [u, zero_u] = fzero(parab2,[0, 3])
Or as
>> [u, zero_u] = fzero('x.^2-4',[0, 3]) u = 2 zero_u =
0

13
Bruce Mayer, PE

The function handle method (method 2) is the fastest method, followed by method 1. In addition to speed improvement, another advantage of using a function handle is that it provides access to subfunctions, which are normally not visible outside of their defining .m-file.
If we give a SubFunction a handle, or nickname, then we can reach into the function file to engage the useful SubFcn withOUT using the main function
Bruce Mayer, PE

14
Types of User Defined Fcns

The PRIMARY function is the first function in a .m-file and typically contains the main program. Following the primary function in the same file can be any number of subfunctions, which can serve as subroutines that support the primary function. That is, .m-files can contain code for more than one function. Additional functions within the file are called subfunctions, and these are only visible to the primary function or to other subfunctions in the same file.
Bruce Mayer, PE

15
PRIMARY Function
Usually the primary function is the ONLY function in a .m-file that we can call from the MATLAB Command Window or from another .m-file function You invoke the Primary function using the name of the .m-file in which it is defined.
We normally use the same name for the function and its file, but if the function name differs from the file name, you must use the FILE name to invoke the function.

16
Bruce Mayer, PE

ANONYMOUS functions enable creation of a simple function withOUT needing to write a separate a .m-file for it.
You can construct an anonymous function either at the MATLAB command line or from within another function or script.
Thus, anonymous functions provide a quick way of making a function from any MATLAB expression withOUT the need to create, name, and save a file.
More on anonymous fcns in a few slides
Bruce Mayer, PE

17

SUBFUNCTIONS are placed in the primary function and are called by the primary fcn
You can use multiple functions within a single primary function m-file
NESTED functions are functions defined within another function.

They can help to improve the readability of your program and also give you more flexible access to variables in the .m-file. Produce Nesting Levels
The difference between nested functions and subfunctions is that subfunctions normally cannot be accessed outside of their primary function file
Bruce Mayer, PE

18

OVERLOADED functions are functions that respond differently to different types of input arguments. They are similar to overloaded functions in any object-oriented language.
For example, an overloaded function can be created to treat integer inputs differently than inputs of class double (precision).
PRIVATE functions enable you to restrict access to a function. They can be called only from a .m-file function in the parent directory
Search PATHs will NOT work.
Bruce Mayer, PE

19
Function Function
The term function function is not a separate function type but refers to any function that accepts another function as an input argument, such as the function fzero or fminbnd You can pass a function to another function using a function handle.

20
Bruce Mayer, PE
Anonymous Functions
The syntax for creating an anonymous function from an expression is
fhandle = @(arglist) expr
Where
The Term arglist is a comma-separated list of input arguments to be passed to the function The Term expr is any single, valid MATLAB expression.

21
Bruce Mayer, PE
Anonymous Fcn Unit Vector

Consider a Direction in 3D space defined by LoA running from Pt-A to Pt-B with CoOrds as shown Define DIRECTION Vector AB AB xB x A i
xB , y B , z B
x A , y A , z A
yB y A j z B z A k
Or using Notation
y AB xABi AB j z AB z
Bruce Mayer, PE

22

Next Calculate the Geometric Length, AB, of The Direction Vector AB using Pythagorus
xB , y B , z B
AB AB LAB
2 2 2 x AB y AB z AB
x A , y A , z A
Now AB has the same Direction as u, but a different length

23
Normalizing AB to its Length will produce a vector of unit Length; i.e., u

Bruce Mayer, PE

Normalize AB to Produce
xB , y B , z B
AB AB u LAB AB y xi j zk
2 2 2 x AB y AB z AB
x A , y A , z A
the s for this case Create MATLAB x AB 40m y AB 80m Anonymous Fcn: uV(x, y, z) z AB 30m
24
Bruce Mayer, PE

Write Anon Fcn uV completely in the COMMAND Window Test using conditions Given at Right
xB , y B , z B
x A , y A , z A
Also find Space Angles by acosd(uAB)

25
Bruce Mayer, PE
TWO versions of uV anon fcn

>> uV1 = @(delX, delY, delZ) [delX delY delZ]/norm([delX delY delZ]) uV1 = @(delX,delY,delZ)[delX,delY,delZ]/norm([delX,delY,delZ]) >> uVa = uV1(13,-29,17) uVa = 0.3607 -0.8046 0.4717
>> uV2 = @(dx, dy, dz) [dx dy dz]/sqrt(sum(dx^2 + dy^2 + dz^2)) uV2 = @(dx,dy,dz)[dx,dy,dz]/sqrt(sum(dx^2+dy^2+dz^2)) >> uVb = uV2(13,-29,17)
uVb = 0.3607
-0.8046
0.4717
>> SpcQ = acosd(uVa) SpcQ = 68.8572 143.5740

26
61.8568
Bruce Mayer, PE
Anonymous Function in fzero

Solve the Transcendental Equation
>> cos_ln = @(x) 7*cos(x) - log(x+1) cos_ln = @(x)7*cos(x)log(x+1) >> x_zero = fzero(cos_ln, 2) x_zero =
7 cos x ln x 1
Collect Terms on One Side, and use fzero to find x that satisfies eqn near x=2
7 cos x ln x 1 0
27
1.4429
Bruce Mayer, PE
@Cos_ln (x) Graphed: 0-2.5

8 6 4 2 0
v
-2 -4 -6 -8 -10
>> u = linspace(0, 2.5*pi, 300); >> v = cos_ln(u); >> xZ = [0,8]; yZ = [0, 0]; >> plot(u,v, xZ,yZ, 'LineWidth',3), grid, xlabel('u'), ylabel('v'); >> Z1 = fzero(cos_ln,2) Z1 = 1.4429 >> Z2 = fzero(cos_ln,5) Z2 = 4.9705 >> Z3 = fzero(cos_ln,8) Z3 = 7.5425
4 u

28
Bruce Mayer, PE
ANONYMOUS Function example

Build, completely in the Command Window, 1n a function that returns the nth Root of a Scalar Base
zB
>> nth_root = @(B,n) B.^(1./n); >> z = nth_root(31,3) z = 3.1414 >> z1 = nth_root(-99,4.3) z1 = 2.1683 + 1.9428i >> nth_root(10, [2:6]) ans = 3.1623 2.1544 1.7783 1.5849
29
1.4678
Bruce Mayer, PE
Anonymous Functions cont

You can pass the handle of an anonymous function to other functions.
For example, to find the minimum of the polynomial 4x2 50x + 5 over the interval [10, 10] >>poly1 = @(x) 4*x.^2 - 50*x + 5; >>fminbnd(poly1, -10, 10) ans = 6.2500
Omit the Handle for a One-Time fcn use

fminbnd(@(x) 4*x.^2 - 50*x + 5, -10, 10)

30
Bruce Mayer, PE
Calling One Fcn within Another

One anonymous function can call another to implement function composition. Consider the function h(x) = 5sin(x3). It is composed of the fcns g(y) = 5sin(y) and y = f(z) = z3 h(x) = g(f(x))
In the following session the function whose handle is h calls the functions whose handles are f and g.
>>f = @(x) x.^3; >>g = @(x) 5*sin(x); >>h = @(x) g(f(x)); >>h(2) ans = 4.9468
Bruce Mayer, PE

31
Variables and Anonymous Fcns

Variables can appear in anonymous functions in two ways:
1. As variables specified in the argument list, as for example f = @(x) x.^3; 2. As variables PreDefined in the body of the expression, as for example with the variables A and B in plane = @(x,y) A*x + B*y

32
Bruce Mayer, PE
Vars & Anonymous-Fcns cont

When the function is created MATLAB captures the values of these variables and retains those values for the lifetime of the function handle. >> A = 3; B = 7;
If the values of A or B are changed after the handle is created, their values associated with the handle do NOT change. >> plane = @(x,y) A*x + B*y >> P1 = plane (1,2) P1 = 17 >> A = 9; B = 14; >> P2 = plane (1,2) P2 = 17
Bruce Mayer, PE

33
SubFunctions
A function .m-file may contain more than one user-defined function.
The first defined function in the file is called the primary function, whose name is the same as the m-file name. All other functions in the file are called subfunctions.
Subfunctions are normally visible only to the primary function and other subfunctions in the same file;
that is, they normally cannot be called by programs or functions outside the primary fcn file
this limitation can be removed with fcn handles
Bruce Mayer, PE

34
SubFunctions cont
Create the primary function first with a function definition line and its defining code, and name the .m-file with this function name as usual. Next, create within the .m-file each subfunction with its own function definition line and defining code
The order of the subfunctions does not matter, but function names must be unique within the primary function .m-file.

35
Bruce Mayer, PE
SubFunction Example
function [avg, med] = newstatsSF(u) % Primary function % Bruce Mayer, PE * 06Feb12 * ENGR25 % file = newstatsSF.m (SHOULD match fcn name) % NEWSTATS Find mean and median with internal functions. n = length(u); avg = mean(u, n); med = median(u, n);
function a = mean(v, n) % Calculate average. a = sum(v)/n; % Subfunction
function m = median(v, n) % Calculate median. w = sort(v); if rem(n, 2) == 1 m = w((n+1) / 2); else m = (w(n/2) + w(n/2+1)) / 2; end
36
% Subfunction
Bruce Mayer, PE
SubFunction Example Results

>> w = [12:0.37:209]; >> z = log(w).*(cos(w)).^2; >> [zavg, zmed] = newstatsSF(z)
zavg = 2.2590
zmed = 2.1168
37
Bruce Mayer, PE
Function-Call Precedence
The order in which MATLAB checks for functions is very important. When a function is called from within an .m-file, MATLAB
1. first checks to see if the function is a built-in function such as sin.
2. Next it checks to see if it is a subfunction in a primary function .m-file 3. then checks to see if it is a private function
which is a function m-file residing in the PRIVATE subdirectory of the calling function
4. Then MATLAB checks for normal .m-files on your search path

38
Bruce Mayer, PE
Function-Call Precedence cont

Thus, because MATLAB checks for a subfunction before checking for private and standard .m-file functions, you may use subfunctions with the same name as another existing m-file
This feature allows you to name subfunctions without being concerned about whether another function exists with the same name, so you need not choose long function names to avoid conflicts This feature also protects you from using another function unintentionally.
Bruce Mayer, PE

39
SubFunction Example
This example shows how the MATLAB m-function mean can be superceded by our own definition of the mean, one which gives the Root-Mean Square (RMS) value.
The function mean is a subfunction.
The function residual_x is the primary function.

function r = residual_x(a) r = a - mean(a); % function w = mean(z) w = sqrt(sum(z.^2))/length(z);

40
Bruce Mayer, PE
SubFunction Example cont

Note that mean is a std MATLAB .m-File
Suggest checking mean in MATLAB Help >> v = [ 4 -4]; >> r1 = residual_x(v) r1 = 1.1716 -6.8284
Use RMS residual fcn on [4,-4]

Note: RMS mean = 2.8284
The ReDefined mean does NOT change the standard MATLAB version
>> r2 = v - mean(v) r2 = 4 -4
Bruce Mayer, PE

41
SubFunction Assessment
The use of subfunctions enables you to reduce the no. of files that define your fcns
For example, if it were not for the subfunction mean in the previous example, we would have had to define a separate .m-file for our mean function and give it a different name so as not to confuse it with the MATLAB fcn of the same name
Subfunctions are normally visible only to the primary function and other subfunctions in the same file
However, we can use a function handle to allow access to the subfunction from outside the m-file
Bruce Mayer, PE

42
All Done for Today
Some Root Mean Square Calculations

43
Bruce Mayer, PE
Engr/Math/Physics 25
Appendix
Bruce Mayer, PE
Licensed Electrical & Mechanical Engineer
f x 2 x 7 x 9 x 6
3 2
44
BMayer@ChabotCollege.edu
Bruce Mayer, PE
@Cos_ln (x) Graphed

8 6 4 2
y = cos n(x)
0 -2
cos_ln = @(x) 7*cos(x) - log(x+1) xplt = linspace(0,3); yplt = cos_ln(xplt); -6 plot(xplt,yplt) grid -8 xlabel('x') ylabel('y = cos_ln(x)')
-4 -10 0 0.5 1 1.5 x 2 2.5
Bruce Mayer, PE

45

>> uV1 = @(delX, delY, delZ) [delX delY delZ]/(sqrt(sum([delX delY delZ].*[delX delY delZ]))); >> uVtest1 = uV1(7, -9, 4) uVtest1 = 0.5793 -0.7448 0.3310
>> uV2 = @(delX, delY, delZ) [delX delY delZ]/norm([delX delY delZ]); >> uVtest2 = uV2(7, -9, 4) uVtest2 = 0.5793 -0.7448 0.3310
46
Bruce Mayer, PE

the s for this case x AB 40m y AB 80m
z AB 30m
Use uv2 to find
uT = -0.4240 0.8480 0.3180
>> SpcAng = acosd(uT) SpcAng = 115.0873 32.0054

47
71.4580
Bruce Mayer, PE
Anonymous Fcns: Multi-Inputs

You can create anonymous functions having more than one input. For pythag x 2 y 2 example, define the function
>> pythag = @(x,y) sqrt(x.^2 + y.^2);
>> c = pythag(13,17) c = 21.4009 >> pythag([3,7],[4,11]) ans = 5.0000 13.0384
48
Bruce Mayer, PE

ENGR-25 Lec-07 Sp12 Functions-3 Handles Types

Încărcat de

Informații document

Descriere originală:

Drepturi de autor

Formate disponibile

Partajați acest document

Partajați sau inserați document

Opțiuni de partajare

Vi se pare util acest document?

Este necorespunzător acest conținut?

Drepturi de autor:

Formate disponibile

ENGR-25 Lec-07 Sp12 Functions-3 Handles Types

Încărcat de

Drepturi de autor:

Formate disponibile

Engr/Math/Physics 25

Function Handle (MATLAB help)

where sine_handle is a user-selected name for the handle (or NickName).

Function Handles cont

Engineering/Math/Physics 25: Computational Methods

Function Handles cont

Create a handle to the natural log (ln) function

>> ln_handle = @log; >> gen_plot(ln_handle,1:99)

Function Handles cont

Engineering/Math/Physics 25: Computational Methods

3. As an inline function object 4. As a string expression.

Engineering/Math/Physics 25: Computational Methods

xplt = linspace(-5,5); yplt = parab(xplt) plot(xplt,yplt) grid xlabel('x') ylabel('parab(x)')

Engineering/Math/Physics 25: Computational Methods

Calling Functions cont

Engineering/Math/Physics 25: Computational Methods

Calling Functions cont

3. As an inline function object:

Calling Functions cont

Engineering/Math/Physics 25: Computational Methods

Calling Functions cont

Engineering/Math/Physics 25: Computational Methods

Types of User Defined Fcns

Engineering/Math/Physics 25: Computational Methods

Engineering/Math/Physics 25: Computational Methods

Types of User Defined Fcns

Engineering/Math/Physics 25: Computational Methods

Types of User Defined Fcns

NESTED functions are functions defined within another function.

Engineering/Math/Physics 25: Computational Methods

Types of User Defined Fcns

Engineering/Math/Physics 25: Computational Methods

Engineering/Math/Physics 25: Computational Methods

Engineering/Math/Physics 25: Computational Methods

Anonymous Fcn Unit Vector

Engineering/Math/Physics 25: Computational Methods

Anonymous Fcn Unit Vector

Now AB has the same Direction as u, but a different length

Normalizing AB to its Length will produce a vector of unit Length; i.e., u

Anonymous Fcn Unit Vector

Anonymous Fcn Unit Vector

Also find Space Angles by acosd(uAB)

TWO versions of uV anon fcn

>> SpcQ = acosd(uVa) SpcQ = 68.8572 143.5740

Engineering/Math/Physics 25: Computational Methods

Anonymous Function in fzero

@Cos_ln (x) Graphed: 0-2.5

Engineering/Math/Physics 25: Computational Methods

ANONYMOUS Function example

Anonymous Functions cont

Omit the Handle for a One-Time fcn use

Engineering/Math/Physics 25: Computational Methods

Calling One Fcn within Another

Engineering/Math/Physics 25: Computational Methods

Variables and Anonymous Fcns

Engineering/Math/Physics 25: Computational Methods

Vars & Anonymous-Fcns cont

Engineering/Math/Physics 25: Computational Methods

Engineering/Math/Physics 25: Computational Methods

Engineering/Math/Physics 25: Computational Methods

SubFunction Example Results

4. Then MATLAB checks for normal .m-files on your search path

Function-Call Precedence cont