Chapter 6 基本的使用者定義函式

Chapter 6

基本的使用者定義函式

Hung-Yuan Fan (范洪源)

Department of Mathematics, National Taiwan Normal University, Taiwan

Spring 2019

Outline

6.1 MATLAB 函式介紹

6.2 MATLAB 的變數傳遞方式: 按值傳遞 6.3 選擇性引數

6.4 使用共用記憶體分享資料 6.5 函式呼叫間的資料保存 6.6 函式握把

6.7 匿名函式

6.8 MATLAB 內建函式: 排序與亂數涵式

Section 6.1

MATLAB 函式介紹

M 檔案的類型

儲存 MATLAB 程式碼的檔案稱為 M 檔案 (副檔名是.m)，包含

1 程序檔案或稱底稿檔案（script files）

它是由㇐系列宣告式所組成的檔案。

執行結果如同把所有的指令直接鍵入指令視窗㇐樣。

任何由程序檔所產生的變數，都會繼續存留在工作區內而互 相影響。

2 MATLAB 函式 (MATLAB functions)

㇐種特殊類型的 M 檔案，可在自己專屬的工作區內執行。

藉由輸入引數清單（input argument list）接受輸入資料。

經由輸出引數清單（output argument list）傳回計算結果 給呼叫的程式。

在函式內使用的變數是區域變數（local variable），因此即 使工作區內已使用相同名稱的變數，它們彼此之間不會混 淆。

函式的架構

完整的函式包括函式定義列、H1 列（唸成 H-one line）、

函式說明文字區，以及函式的主體四個部分。

function

filename(in1,in2,. . .)

% H1 comment line

% Other comment lines

· · ·

(Executable code)

· · ·

(return) % 可省略此宣告式

end

function

入與輸出引數清單。

H1 Comment Line

在函式宣告

function之後的第㇐列註解，稱為 H1 註解行

（H1 comment line）。

它必須只包含㇐行註解文字，用以表明整個函式的目的。

此行文字的特別意義，是讓 MATLAB 藉由 lookfor 指令 搜尋並顯示此函式用途。

語法: lookfor

keyword

MATLAB 會搜尋函式名稱或是 H1 列中是否包含該關鍵字

keyword

H1 列和註解說明文字 (1/2)

範例: 函式 vec_plus.m

function

vec_plus(x,y)

% vec_plus Sum of two numbers or vectors.

% vec_plus(X,Y) computes X+Y and returns the result,

% where X and Y can be scalars or vectors.

% function's body starts here total = x + y;

>> vec_plus(2,ones(2,1)) ans =

3

H1 列和註解說明文字 (2/2)

>> help

vec_plus

vec_plus Sum of two numbers or vectors.

vec_plus(X,Y) computes X+Y and returns the result, where X and Y can be scalars or vectors.

>> lookfor

sum

vec_plus - Sum of two numbers or vectors.

reciproc_sum - Function-valued tensor for 1/(xi_1 + ... + xi_d) StatisticsByGroupMapReduceExample - Compute Summary Statistics by Group Using

MapReduce

summer - Shades of green and yellow colormap

uiresume - Resume execution of blocked MATLAB code.

.. .

函式的引數與傳回值

多個輸出引數的函式

範例: 函式 vec_minmax.m

function

vec_minmax(v)

% vec_minmax 找出向量元素的最小值與最大值。

% 函式 vec_minmax(v) 計算向量 v 所有元素的最小值 mn

% 和最大值 mx，並且傳回這兩個輸出引數。

mn = min(v);

mx = max(v);

>> [min_val, max_val] = vec_minmax([4, -5, 7, 1]) min_val =

-5 max_val =

7

查詢此函式的線上說明內容

>> help

vec_minmax

vec_minmax 找出向量元素的最小值與最大值。

函式 vec_minmax(v) 計算向量 v 所有元素的最小值 mn 和最大值 mx，並且傳回這兩個輸出引數。

>> lookfor

最小值

vec_minmax

>>

不需要括號的函式呼叫方式

函式如果沒有輸出引數，就不需要將輸入的引數括起來。

例如，如果 my_func(a, b) 沒有輸出引數，可用下面兩種方 法呼叫：

my_func(a, b); % 需要括號的呼叫方式

my_func

a b; % 不需括號的呼叫: 將 a、b 視為字串

axis([-4, 4, 0, 20]); % 輸入引數是 double 型態的向量 axis

on; % 效果和 axis('on') ㇐樣

axis

off; % 效果和 axis('off') ㇐樣

沒有輸出引數的範例 (檔名: no_outarg.m)

function

fprintf(' 輸入引數分別是%s 和

%s \n',x, y);

>> no_outarg

2 -10

>> no_outarg(2, -10) 輸入引數分別是 和

>> no_outarg('2',

'-10')

Section 6.2

MATLAB 的變數傳遞方式: 按值傳遞

按值傳遞與按址傳遞

MATLAB 程式使用按值傳遞（pass-by-value）的方式，進 行程式與函式間的溝通。

C 語言是採取按址傳遞（pass-by-address）的方式，進行程 式與函式間的溝通。

當程式呼叫函式時，MATLAB 便複製實際引數，並傳遞這 些實際引數的備份給函式使用。

即使函式更改了輸入引數值，也不會影響到呼叫程式的原始 資料。

這種特點可防止在函式中因產生某個錯誤，而無意間修改到 呼叫程式的原始變數值。

函式 sample.m

function out = sample(a,b)

fprintf('In sample: a = %f, b = %f

\n',a,b);

a = b(1) + 2*a;

b = a .* b;

out = a + b(1);

fprintf('In sample: a = %f, b = %f

\n',a,b);

呼叫上述函式的主程式 test_sample.m a = 2; b = [6 4];

fprintf('Before sample: a = %f, b = %f

\n',a,b);

out = sample(a,b);

fprintf('After sample: a = %f, b = %f

\n',a,b);

fprintf('After sample: out = %f

\n',out);

主程式的執行結果

>> test_sample

Before sample: a = 2.000000, b = 6.000000 4.000000

In sample: a = 2.000000, b = 6.000000 4.000000 In sample: a = 10.000000, b = 60.000000 40.000000

After sample: out = 70.000000

>>

Section 6.3

選擇性引數

許多 MATLAB 函式支援選擇性的輸入引數及輸出引數，例 如: plot、max 等函式。

x_max = max(x);

[x_max,ii_max] = max(x);

MATLAB 有關選擇性引數資訊的函式

nargin: 傳回用來呼叫函式的實際輸入引數數目，是 number of argument input 的縮寫。

nargout: 傳回用來呼叫函式的實際輸出引數數目，是 number of argument output 的縮寫。

nargchk: 假如用來呼叫函式的引數太少或是太多，將傳回

㇐個錯誤訊息。

error: 顯示錯誤的訊息，並放棄執行產生錯誤的函式。用 在當引數產生的錯誤是嚴重的 (fatal) 情況。

warning: 顯示警告的訊息，並繼續執行函式。用在當引數 的錯誤並不嚴重，而函式可以繼續執行的情況。

inputname: 傳回對應輸入引數清單特定次序的實際變數名

上述函式的語法 (1/2)

nargchk 語法

msg = nargchk(min_args,max_args,num_args);

min_args: 引數最小數目，max_args: 引數最大數目，

num_args: 實際引數數目。

假使引數的數目不在可接受的範圍，將會產生㇐個標準的錯 誤訊息。

假使引數的數目在可接受範圍內，則函式將會傳回㇐個空字 串。

error 語法

error('msg')，其中 msg 是包含錯誤訊息的字串。

error 可與 nargchk 互相搭配使用。

當程式發生錯誤時，產生㇐個錯誤訊息並停止執行。

如果程式沒有錯誤，就只輸出㇐個空字串。

上述函式的語法 (2/2)

warning 語法

warning('msg')，其中 msg 是包含警告訊息的字串。

會告知使用者發生問題的函式名稱，以及程式發生問題的位 置，但程式仍繼續執行而不會中斷。

inputname 語法

name = inputname(argno);

會傳回所使用的真實引數名稱，其中 argno 是引數的序數。

如果引數是個變數，函式會傳回變數名稱。

假如引數是㇐段敘述，則會傳回㇐個空字串。

範例 6.3: 使用選擇性引數

產生㇐個函式 pplar_value，將直角座標 (x, y) 轉換成等 價的極座標 (r, θ)。

如果只有輸入㇐個引數，則函式將會假設 y 值為 0，並繼 續完成轉換的計算。

正常的情況下，函式將傳回距離 r 與角度 θ(以度為單位) 兩個數值，但如果呼叫此函式的敘述式只有㇐個輸出引數，

它將只會傳回距離值 r。

MATLAB 程式碼 (檔名: polar_value.m)

function

error(msg);

if

end

if

msg = 'x and y are zero: angle is meaningless!';

warning(msg);

end

mag = sqrt(x.^2 + y.^2);

if

程式執行結果 (1/2)

>> [r, theta] = polar_value(1, -1) r =

1.4142 theta =

-45

>> r = polar_value(1, -1) r =

1.4142

>> [r, theta] = polar_value(-2) r =

2 theta =

程式執行結果 (2/2)

>> [r, theta] = polar_value(3, 4) r =

5 theta =

53.1301

>> [r, theta] = polar_value(0, 0)

Warning: x and y are zero: angle is meaningless!

> In polar_value at 32

0 theta =

Section 6.4

使用共用記憶體分享資料

共用記憶體與全域變數

除了引數清單之外，MATLAB 函式也能在工作區內使用

共 用記憶體，以交換彼此間的資料。

共用記憶體（global memory）是㇐種特別型態的記憶體，

能在任何工作區內存取。

對於分享函式間的大量資料特別有用，因為每次函式被呼叫 時，就不需要複製整個資料集合。

全域變數 (global variables) 是藉由 global 宣告來產生，

其宣告形式如下：

區域變數與全域變數

在 MATLAB 函式內部的變數均是區域變數 (local variables)。

以大寫字⺟宣告全域變數，使其容易與區域變數區別。

通常在函式中的使用說明與第㇐個可執行的宣告式之間，宣 告所有的全域變數。

每個全域變數在函式內第㇐次使用前，必須先宣告其為全域 變數。如果在局部工作區產生㇐個變數後才宣告其為全域變 數，將會產生錯誤。

全域變數的範例

使用 global 宣告的函式: test_global.m

function

global

\n', VAR);

>>

global

>> VAR = 3.14;

>> test_global(-2) 在函式內，VAR = -6.28

>> num

Undefined function or variable 'num'.

>> VAR

Section 6.5

函式呼叫間的資料保存

區域變數值的續存

續存記憶體（persistent memory）

㇐種特別類型的記憶體，只允許在函式內存取。

在函式呼叫之間，其值保持不變。

續存變數宣告式

persistent var1 var2 var3. . .

其中 var1、var2、var3 等，是保存在續存記憶體的變數。

範例 6.5: 動態平均值 (1/4)

1. 宣告問題

產生㇐個函式，當輸入㇐個新的數值時，即時計算資料的動 態平均及標準差。這個函式也需要應使用者的需要，重置動 態總和統計值。

2. 定義輸入和輸出 兩種類型的輸入值：

1 使用字元字串「reset」重置動態總和統計值歸零。

2 輸入資料集合裡的數值，每呼叫函數㇐次，便顯示㇐個數值。

輸出值: 提供資料的動態平均值與標準差。

3. 設計演算法

Step 1

Step 2

Step 3

Step 4

如果資料不夠的話，就傳回零。

範例 6.5: 動態平均值 (2/4)

4. MATLAB 程式碼 (函式檔名: runstats.m)

function

persistent

msg = nargchk(1,1,nargin); error(msg);

if

n = 0; sum_x = 0; sum_x2 = 0;

else

n = n + 1; sum_x = sum_x + x; sum_x2 = sum_x2 + x^2;

end if

ave = 0; std = 0;

elseif

ave = sum_x; std = 0;

else

ave = sum_x / n;

範例 6.5: 動態平均值 (3/4)

4. MATLAB 程式碼 (主程序檔名: test_runstats.m)

% First reset running sums [ave, std] = runstats('reset');

% Prompt for the number of values in the data set nvals = input('Enter number of data: ');

% Get input values

for

% Prompt for next value

string = ['Enter value ' int2str(ii) ': '];

x = input(string);

% Get running statistics [ave, std] = runstats(x);

% Display running statistics

fprintf('Ave = %8.4f; Std = %8.4f

\n',ave,std);

範例 6.5: 動態平均值 (4/4)

5. 測試程式

試輸入五筆資料 3, 2, 3, 4, 2.8，並計算其移動平均值與標準差。

>> test_runstats

Enter number of data: 5 Enter value 1: 3

Ave =

3.0000; Std = 0.0000

Ave =

2.5000; Std = 0.7071

Ave =

2.6667; Std = 0.5774

Ave =

3.0000; Std = 0.8165

Section 6.6

函式握把

MATLAB 的資料型態

何謂函式握把?

函式握把（function handle）是 MATLAB 的㇐種資料型 態，它保有呼叫㇐個函式所需的資訊。

MATLAB 提供兩種方法來產生函式握把：

1 使用@運算子來產生函式握把時，只需要將運算子放在函式 名稱前面即可。

fh = @函式名稱;

2 使用 str2func 產生函式握把時，必須將函式的名稱當成輸 入引數的字串。

fh = str2func('函式名稱');

函式握把的範例 (1/2)

使用者定義的函式: my_func.m

function

>> fh1 = @my_func; % 宣告 fh1 為㇐個函式握把

>> [fh1(4), my_func(4)]

ans =

9 9

>> fh2 = @randn;

>> fh2() % 若沒有輸入引數時，必須加上圓括弧 () ans =

函式握把的範例 (2/2)

>> whos

Name Size Bytes Class ans 1

× 1 8

fh1 1

× 1 32

× 1 32

>>> feval(fh1, 4) % 效果與 fh1(4) 相同 ans =

9

>> func2str(fh1) % 找回函式握把 fh1 的原函式名稱 ans =

my_func

處理函式握把的 MATLAB 函式

Section 6.7

匿名函式

匿名函式（anonymous function）是㇐個「沒有名稱」的函 式。

它是用單㇐行 MATLAB 敘述所宣告的函式，而且會回傳㇐

個函式握把，然後可以用此握把來執行此函式。

可以在指令視窗裡直接定義㇐個匿名函式，而不用把函式寫 在 M 檔案裡。

㇐般形式為

單自變量函數的範例

>> f = @(x) cos(x) - x; % 宣告 f 是㇐個函式握把

>> z =

fzero(f,[0,pi/2]) % 求出函數 f 的零根

0.7391

>> x = linspace(0,pi/2); y = f(x); fz = f(z);

>> plot(x,y,'b-',x,zeros(size(x)),'k-',z,fz,'ro');

雙自變量函數的範例

>> g = @(x,y) x./(x.^2+y.^2+1);

>> g(1,1) ans =

0.3333

>> ezsurf(g,[-5,5,-5,5]);

Section 6.8 MATLAB 內建函式:

排序與亂數涵式

內建排序函式 sort

sort 函式可將㇐組資料排序成遞增 (ascending order) 或 遞減順序 (descending order)。

如果這組資料是㇐個行或列向量，整組資料會進行排序。

如果這組資料是㇐個二維矩陣，則矩陣的

行向量 (column vectors) 會被分別排序

宣告形式如下:

函式 sort 的使用範例

>> a = [1 4 5 2 8];

>> sort(a,’descend’) ans =

8 5 4 2 1

>> b = [1 5 2; 9 7 3; 8 4 6];

>> b >> sort(b)

b = ans =

1 5 2 9 7 3 8 4 6

1 4 2 8 5 3 9 7 6

內建排序函式 sortrows

sortrows 函式是 sort array rows 之意。

將㇐個矩陣的資料依照某㇐或某些特定欄位 (columns) 的 資料進行遞增或遞減排序。

宣告形式如下:

宣告式 res = sortrows(a,[m n])

主要先針對第 m 個欄位的列資料進行排序。

在第 m 個欄位中，若有兩個或兩個以上的元素相同，則再 依據第 n 個欄位相對應的列資料進行排序。

函式 sortrows 的使用範例

>> c = [1 7 2; 9 7 3; 8 4 6];

>> c >> sortrows(c,-1) >> sortrows(c,[2 3])

c = ans = ans =

1 7 2 9 7 3 8 4 6

9

8

1

8 4 6 1

7 2

7 3

常用的內建亂數函式

下表為函式 rand 和 randn 的宣告形式:

宣告形式 說明

ramd 或 rand() 產生㇐個在 [0, 1) 區間內均勻分布的亂數。

rand(n) 產生元素在 [0, 1) 區間內均勻分布的 n× n 亂數矩陣。

rand(m,n) 產生元素在 [0, 1) 區間內均勻分布的 m× n 亂數矩陣。

randn 或 randn() 產生㇐個標準常態分布的亂數。

randn(n) 產生元素為標準常態分布的 n× n 亂數矩陣。

randn(m,n) 產生元素為標準常態分布的 m× n 亂數矩陣。

Thank you for your attention!