freemat-4.2

FreeMat

Generated by Doxygen 1.8.1.1

Thu Jul 25 2013 17:18:37

Contents

1 FreeMat Documentation 1

2 Array Generation and Manipulations 3

2.1 ARRAYFUN Apply a Function To Elements of an Array . . . . . . . . . . . . . . . . . . . . . . . 4

2.1.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2.2 ASSIGN Making assignments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2.2.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2.3 CELL Cell Array of Empty Matrices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2.3.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2.3.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

2.4 CELLFUN Appy a Function To Elements of a Cell Array . . . . . . . . . . . . . . . . . . . . . . . 6

2.4.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

2.5 CIRCSHIFT Circularly Shift an Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

2.5.1 USAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

2.5.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

2.6 COND Condition Number of a Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

2.6.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

2.6.2 Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

2.6.3 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

2.7 DET Determinant of a Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

2.7.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

2.7.2 Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

2.7.3 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

2.8 DIAG Diagonal Matrix Construction/Extraction . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

2.8.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

2.8.2 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

2.9 EXPM Matrix Exponential . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

2.9.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

2.9.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

2.10 EYE Identity Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

2.10.1 USAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

ii CONTENTS

2.10.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

2.11 FIND Find Non-zero Elements of An Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

2.11.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

2.11.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

2.12 FLIPDIM Reverse a Matrix Along a Given Dimension . . . . . . . . . . . . . . . . . . . . . . . . . 15

2.12.1 USAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

2.12.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

2.13 FLIPLR Reverse the Columns of a Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

2.13.1 USAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

2.13.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

2.14 FLIPUD Reverse the Columns of a Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

2.14.1 USAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

2.14.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

2.15 IPERMUTE Array Inverse Permutation Function . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

2.15.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

2.15.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

2.16 ISFLOAT Test for Floating Point Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

2.16.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

2.17 ISINTEGER Test for Integer Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

2.17.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

2.18 LINSPACE Linearly Spaced Vector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

2.18.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

2.18.2 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

2.19 LOGSPACE Logarithmically Spaced Vector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

2.19.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

2.19.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

2.20 MESHGRID Generate Grid Mesh For Plots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

2.20.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

2.20.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

2.21 NAN Not-a-Number Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

2.21.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

2.21.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

2.22 NDGRID Generate N-Dimensional Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

2.22.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

2.22.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

2.23 NONZEROS Retrieve Nonzero Matrix Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

2.23.1 USAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

2.23.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

2.24 NORM Norm Calculation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

2.24.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Generated on Thu Jul 25 2013 17:17:13 for FreeMat by Doxygen

CONTENTS iii

2.24.2 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

2.25 NUM2STR Convert Numbers To Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

2.25.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

2.26 ONES Array of Ones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

2.26.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

2.26.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

2.27 PERMUTE Array Permutation Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

2.27.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

2.27.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

2.28 PINV Moore-Penrose Pseudoinverse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

2.28.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

2.28.2 Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

2.28.3 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

2.29 RANK Calculate the Rank of a Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

2.29.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

2.29.2 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

2.30 RCOND Reciprocal Condition Number Estimate . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

2.30.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

2.30.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

2.31 REPMAT Array Replication Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

2.31.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

2.31.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

2.32 RESHAPE Reshape An Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

2.32.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

2.32.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

2.33 RREF Reduced Row Echelon Form of a Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

2.33.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

2.34 SHIFTDIM Shift Array Dimensions Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

2.34.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

2.34.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

2.35 SORT Sort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

2.35.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

2.35.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

2.36 SQUEEZE Remove Singleton Dimensions of an Array . . . . . . . . . . . . . . . . . . . . . . . . 39

2.36.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

2.36.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

2.37 SUBSREF Array Dereferencing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

2.37.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

2.38 TRACE Sum Diagonal Elements of an Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

2.38.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41


iv CONTENTS

2.39 TRANSPOSE Matrix Transpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

2.39.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

2.39.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

2.40 TRIL Lower Triangular Matrix Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

2.40.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

2.41 TRIU Upper Triangular Matrix Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

2.41.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

2.42 UNIQUE Unique . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

2.42.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

2.42.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

2.43 XNRM2 BLAS Norm Calculation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

2.43.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

2.44 ZEROS Array of Zeros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

2.44.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

2.44.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

3 Bitwise Operations 47

3.1 BITAND Bitwise Boolean And Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

3.1.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

3.1.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

3.2 BITCMP Bitwise Boolean Complement Operation . . . . . . . . . . . . . . . . . . . . . . . . . . 47

3.2.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

3.2.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

3.3 BITOR Bitwise Boolean Or Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

3.3.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

3.3.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

3.4 BITXOR Bitwise Boolean Exclusive-Or (XOR) Operation . . . . . . . . . . . . . . . . . . . . . . . 48

3.4.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

3.4.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

4 Object Oriented Programming 51

4.1 AND Overloaded Logical And Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

4.1.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

4.2 CAT Concatenation of Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

4.2.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

4.3 CLASS Class Support Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

4.3.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

4.4 COLON Overloaded Colon Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

4.4.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

4.5 CONSTRUCTORS Class Constructors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

4.5.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53


CONTENTS v

4.6 CTRANSPOSE Overloaded Conjugate Transpose Operator . . . . . . . . . . . . . . . . . . . . . 54

4.6.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

4.7 EQ Overloaded Equals Comparison Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

4.7.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

4.8 GE Overloaded Greater-Than-Equals Comparison Operator . . . . . . . . . . . . . . . . . . . . . 54

4.8.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

4.9 GT Overloaded Greater Than Comparison Operator . . . . . . . . . . . . . . . . . . . . . . . . . 54

4.9.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

4.10 HORZCAT Overloaded Horizontal Concatenation . . . . . . . . . . . . . . . . . . . . . . . . . . 55

4.10.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

4.11 LDIVIDE Overloaded Left Divide Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

4.11.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

4.12 LE Overloaded Less-Than-Equals Comparison Operator . . . . . . . . . . . . . . . . . . . . . . . 55

4.12.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

4.13 LT Overloaded Less Than Comparison Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

4.13.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

4.14 MINUS Overloaded Addition Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

4.14.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

4.15 MLDIVIDE Overloaded Matrix Left Divide Operator . . . . . . . . . . . . . . . . . . . . . . . . . . 56

4.15.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

4.16 MPOWER Overloaded Matrix Power Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

4.16.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

4.17 MRDIVIDE Overloaded Matrix Right Divide Operator . . . . . . . . . . . . . . . . . . . . . . . . . 57

4.17.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

4.18 MTIMES Overloaded Matrix Multiplication Operator . . . . . . . . . . . . . . . . . . . . . . . . . 57

4.18.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

4.19 NE Overloaded Not-Equals Comparison Operator . . . . . . . . . . . . . . . . . . . . . . . . . . 57

4.19.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

4.20 NOT Overloaded Logical Not Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

4.20.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

4.21 OR Overloaded Logical Or Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

4.21.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

4.22 PLUS Overloaded Addition Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

4.22.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

4.23 POWER Overloaded Power Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

4.23.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

4.24 RDIVIDE Overloaded Right Divide Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

4.24.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

4.25 SUBSASGN Overloaded Class Assignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

4.25.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59


vi CONTENTS

4.26 SUBSINDEX Overloaded Class Indexing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

4.26.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

4.27 SUBSREF Overloaded Class Indexing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

4.27.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

4.28 TIMES Overloaded Multiplication Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

4.28.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

4.29 TRANSPOSE Overloaded Transpose Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

4.29.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

4.30 UMINUS Overloaded Unary Minus Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

4.30.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

4.31 UPLUS Overloaded Unary Plus Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

4.31.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

4.32 VERTCAT Overloaded Vertical Concatenation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

4.32.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

5 Base Constants 63

5.1 E Euler Constant (Base of Natural Logarithm) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

5.1.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

5.1.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

5.2 EPS Double Precision Floating Point Relative Machine Precision Epsilon . . . . . . . . . . . . . . 64

5.2.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

5.2.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

5.3 FALSE Logical False . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

5.3.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

5.4 FEPS Single Precision Floating Point Relative Machine Precision Epsilon . . . . . . . . . . . . . . 64

5.4.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

5.4.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

5.5 I-J Square Root of Negative One . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

5.5.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

5.5.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

5.6 INF Infinity Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

5.6.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

5.6.2 Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

5.6.3 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

5.7 PI Constant Pi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

5.7.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

5.7.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

5.8 TEPS Type-based Epsilon Calculation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

5.8.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

5.8.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68


CONTENTS vii

5.9 TRUE Logical TRUE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

5.9.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

6 Optimization and Curve Fitting 71

6.1 FITFUN Fit a Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

6.1.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

6.2 GAUSFIT Gaussian Curve Fit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

6.2.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

6.2.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

6.3 INTERP2 2-D Interpolation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

6.3.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

6.4 INTERPLIN1 Linear 1-D Interpolation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

6.4.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

6.4.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

6.5 POLY Convert Roots To Polynomial Coefficients . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

6.5.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

6.5.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

6.6 POLYDER Polynomial Coefficient Differentiation . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

6.6.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

6.6.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

6.7 POLYFIT Fit Polynomial To Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

6.7.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

6.7.2 Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

6.7.3 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

6.8 POLYINT Polynomial Coefficient Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

6.8.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

6.8.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

6.9 POLYVAL Evaluate Polynomial Fit at Selected Points . . . . . . . . . . . . . . . . . . . . . . . . 82

6.9.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

6.9.2 Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

6.9.3 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

6.10 ROOTS Find Roots of Polynomial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

6.10.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

6.10.2 Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

6.10.3 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

7 Debugging FreeMat Code 85

7.1 DBAUTO Control Dbauto Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

7.1.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

7.2 DBDELETE Delete a Breakpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

7.2.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86


viii CONTENTS

7.3 DBDown Move Down One Debug Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

7.3.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

7.4 DBLIST List Breakpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

7.4.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

7.5 DBSTEP Step N Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

7.5.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

7.6 DBSTOP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

7.6.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

7.7 DBUP Move Up One Debug Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

7.7.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

7.8 FDUMP Dump Information on Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

7.8.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

8 Elementary Functions 89

8.1 ABS Absolute Value Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

8.1.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

8.1.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

8.2 ALL All True Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

8.2.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

8.2.2 Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

8.2.3 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

8.3 ANY Any True Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

8.3.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

8.3.2 Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

8.3.3 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

8.4 CEIL Ceiling Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

8.4.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

8.4.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

8.5 CONJ Conjugate Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

8.5.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

8.5.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

8.6 COV Covariance Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

8.6.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

8.6.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

8.7 CUMPROD Cumulative Product Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

8.7.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

8.7.2 Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

8.7.3 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

8.8 CUMSUM Cumulative Summation Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

8.8.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96


CONTENTS ix

8.8.2 Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

8.8.3 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

8.9 DEAL Multiple Simultaneous Assignments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

8.9.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

8.10 DEC2HEX Convert Decimal Number to Hexadecimal . . . . . . . . . . . . . . . . . . . . . . . . 98

8.10.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

8.10.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

8.11 DIFF Difference Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

8.11.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

8.12 DOT Dot Product Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

8.12.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

8.13 FLOOR Floor Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

8.13.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

8.13.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

8.14 GETFIELD Get Field Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

8.14.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

8.15 HEX2DEC Convert Hexadecimal Numbers To Decimal . . . . . . . . . . . . . . . . . . . . . . . . 100

8.15.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

8.15.2 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

8.16 IMAG Imaginary Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

8.16.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

8.16.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

8.17 IND2SUB Convert Linear Indexing To Multiple Indexing . . . . . . . . . . . . . . . . . . . . . . . 101

8.17.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

8.17.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

8.18 MAX Maximum Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

8.18.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

8.18.2 Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

8.18.3 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

8.19 MEAN Mean Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

8.19.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

8.19.2 Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

8.19.3 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

8.20 MIN Minimum Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

8.20.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

8.20.2 Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

8.20.3 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

8.21 NUM2HEX Convert Numbers to IEEE Hex Strings . . . . . . . . . . . . . . . . . . . . . . . . . . 107

8.21.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

8.21.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107


x CONTENTS

8.22 PROD Product Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

8.22.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

8.22.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

8.23 REAL Real Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

8.23.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

8.23.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

8.24 ROUND Round Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

8.24.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

8.24.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

8.25 STD Standard Deviation Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

8.25.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

8.25.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

8.26 SUB2IND Convert Multiple Indexing To Linear Indexing . . . . . . . . . . . . . . . . . . . . . . . 111

8.26.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

8.26.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

8.27 SUM Sum Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

8.27.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

8.27.2 Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

8.27.3 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

8.28 TEST Test Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

8.28.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

8.29 VAR Variance Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

8.29.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

8.29.2 Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

8.29.3 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

8.30 VEC Reshape to a Vector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

8.30.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

8.30.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

9 FreeMat External Interface 115

9.1 CENUM Lookup Enumerated C Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

9.1.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

9.2 CTYPECAST Cast FreeMat Structure to C Structure . . . . . . . . . . . . . . . . . . . . . . . . . 115

9.2.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

9.3 CTYPEDEFINE Define C Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

9.3.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

9.4 CTYPEFREEZE Convert FreeMat Structure to C Type . . . . . . . . . . . . . . . . . . . . . . . . 116

9.4.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

9.5 CTYPENEW Create New Instance of C Structure . . . . . . . . . . . . . . . . . . . . . . . . . . 117

9.5.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117


CONTENTS xi

9.6 CTYPEPRINT Print C Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

9.6.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

9.7 CTYPEREAD Read a C Structure From File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

9.7.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

9.8 CTYPESIZE Compute Size of C Struct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

9.8.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

9.9 CTYPETHAW Convert C Struct to FreeMat Structure . . . . . . . . . . . . . . . . . . . . . . . . 118

9.9.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

9.10 CTYPEWRITE Write a C Typedef To File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

9.10.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

9.11 IMPORT Foreign Function Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

9.11.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

9.11.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

9.12 LOADLIB Load Library Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

9.12.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

10 Flow Control 123

10.1 BREAK Exit Execution In Loop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

10.1.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

10.1.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

10.2 CONTINUE Continue Execution In Loop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

10.2.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

10.2.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

10.3 ERROR Causes an Error Condition Raised . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

10.3.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

10.3.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

10.4 FOR For Loop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

10.4.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

10.4.2 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

10.5 IF-ELSEIF-ELSE Conditional Statements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

10.5.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

10.5.2 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

10.6 KEYBOARD Initiate Interactive Debug Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

10.6.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

10.6.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

10.7 LASTERR Retrieve Last Error Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

10.7.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

10.7.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

10.8 RETALL Return From All Keyboard Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

10.8.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129


xii CONTENTS

10.8.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

10.9 RETURN Return From Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

10.9.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

10.9.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

10.10SWITCH Switch statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

10.10.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

10.10.2 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

10.11TRY-CATCH Try and Catch Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

10.11.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

10.11.2 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

10.12WARNING Emits a Warning Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

10.12.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

10.13WHILE While Loop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

10.13.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

10.13.2 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

11 FreeMat Functions 135

11.1 ADDPATH Add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

11.1.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

11.2 ASSIGNIN Assign Variable in Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

11.2.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

11.3 BLASLIB Select BLAS library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

11.3.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

11.4 BUILTIN Evaulate Builtin Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

11.4.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

11.5 CLC Clear Dislplay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

11.5.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

11.6 CLOCK Get Current Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

11.6.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

11.6.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

11.7 CLOCKTOTIME Convert Clock Vector to Epoch Time . . . . . . . . . . . . . . . . . . . . . . . . 139

11.7.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

11.7.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

11.8 COMPUTER Computer System FreeMat is Running On . . . . . . . . . . . . . . . . . . . . . . . 139

11.8.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

11.9 DIARY Create a Log File of Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

11.9.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

11.10DOCLI Start a Command Line Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

11.10.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

11.11EDIT Open Editor Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141


CONTENTS xiii

11.11.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

11.12EDITOR Open Editor Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

11.12.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

11.13ERRORCOUNT Retrieve the Error Counter for the Interpreter . . . . . . . . . . . . . . . . . . . . 141

11.13.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

11.14ETIME Elapsed Time Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

11.14.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

11.14.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

11.15EVAL Evaluate a String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

11.15.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

11.15.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

11.16EVALIN Evaluate a String in Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

11.16.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

11.17EXIT Exit Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

11.17.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

11.18FEVAL Evaluate a Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

11.18.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

11.18.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

11.19FILESEP Directory Separation Character . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

11.19.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

11.20HELP Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

11.20.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

11.21HELPWIN Online Help Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

11.21.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

11.22JITCONTROL Control the Just In Time Compiler . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

11.22.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

11.23MFILENAME Name of Current Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

11.23.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

11.24PATH Get or Set FreeMat Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

11.24.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

11.25PATHSEP Path Directories Separation Character . . . . . . . . . . . . . . . . . . . . . . . . . . 146

11.25.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

11.26PATHTOOL Open Path Setting Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

11.26.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

11.27PCODE Convert a Script or Function to P-Code . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

11.27.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

11.28PROFILER Control Profiling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

11.28.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

11.29QUIET Control the Verbosity of the Interpreter . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

11.29.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147


xiv CONTENTS

11.30QUIT Quit Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

11.30.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

11.31REHASH Rehash Directory Caches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

11.31.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

11.32RESCAN Rescan M Files for Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

11.32.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

11.33ROOTPATH Set FreeMat Root Path . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

11.33.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

11.34SAVERETVALUE Save Return Value Of Function . . . . . . . . . . . . . . . . . . . . . . . . . . 149

11.34.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

11.35SIMKEYS Simulate Keypresses from the User . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

11.35.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

11.36SLEEP Sleep For Specified Number of Seconds . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

11.36.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

11.37SOURCE Execute an Arbitrary File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

11.37.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

11.37.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

11.38STARTUP Startup Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

11.38.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

11.39TIC Start Stopwatch Timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

11.39.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

11.39.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

11.40TOC Stop Stopwatch Timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

11.40.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

11.40.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

11.41VERSION The Current Version Number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

11.41.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

11.41.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

11.42VERSTRING The Current Version String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

11.42.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

11.42.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

12 Function Related Functions 153

12.1 INLINE Construct Inline Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

12.1.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

12.1.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

12.2 SYMVAR Find Symbolic Variables in an Expression . . . . . . . . . . . . . . . . . . . . . . . . . 154

12.2.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

12.2.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

13 Functions and Scripts 157


CONTENTS xv

13.1 ANONYMOUS Anonymous Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

13.1.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

13.1.2 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

13.2 FUNC2STR Function to String conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

13.2.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

13.2.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

13.3 FUNCTION Function Declarations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

13.3.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

13.3.2 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

13.4 KEYWORDS Function Keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

13.4.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

13.4.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

13.5 NARGIN Number of Input Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

13.5.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

13.5.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

13.6 NARGOUT Number of Output Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

13.6.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

13.6.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

13.7 SCRIPT Script Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

13.7.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

13.7.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

13.8 SPECIAL Special Calling Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

13.8.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

13.8.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

13.9 STR2FUNC String to Function conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

13.9.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

13.9.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

13.10VARARGIN Variable Input Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

13.10.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

13.10.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

13.11VARARGOUT Variable Output Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

13.11.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

13.11.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

14 OpenGL Models 169

14.1 GLASSEMBLY Create a GL Assembly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

14.1.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

14.2 GLCLUMP Create a GL Clump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

14.2.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

14.3 GLDEFMATERIAL Defines a GL Material . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170


xvi CONTENTS

14.3.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

14.4 GLLINES Create a GL Lineset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

14.4.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

14.5 GLNODE Create a GL Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

14.5.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

15 Handle-Based Graphics 171

15.1 AXES Create Handle Axes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

15.1.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

15.2 AXIS Setup Axis Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

15.2.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

15.3 AXISPROPERTIES Axis Object Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

15.3.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

15.4 CLA Clear Current Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

15.4.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

15.5 CLABEL Add Labels To Contour Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

15.5.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

15.5.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

15.6 CLF Clear Figure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

15.6.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

15.7 CLIM Adjust Color limits of plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

15.7.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

15.7.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

15.8 CLOSE Close Figure Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

15.8.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

15.9 COLORBAR Add Colorbar to Current Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

15.9.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

15.10COLORMAP Image Colormap Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

15.10.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

15.10.2 Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

15.10.3 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

15.11COLORSPEC Color Property Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

15.11.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

15.12CONTOUR Contour Plot Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

15.12.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

15.12.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

15.13CONTOUR3 3D Contour Plot Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

15.13.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

15.13.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

15.14COPPER Copper Colormap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200


CONTENTS xvii

15.14.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

15.14.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

15.15COPY Copy Figure Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

15.15.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

15.16COUNTOUR Contour Object Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

15.16.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

15.17DATACURSORMODE Interactive Data Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

15.17.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

15.18DRAWNOW Flush the Event Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

15.18.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

15.19FIGLOWER Lower a Figure Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

15.19.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

15.20FIGRAISE Raise a Figure Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

15.20.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

15.21FIGURE Figure Window Select and Create Function . . . . . . . . . . . . . . . . . . . . . . . . . 203

15.21.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

15.22FIGUREPROPERTIES Figure Object Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

15.22.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

15.23GCA Get Current Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

15.23.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

15.24GCF Get Current Figure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

15.24.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

15.25GET Get Object Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

15.25.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

15.26GLSHOW Show a GL Assembly in a GL Window . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

15.26.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

15.27GRAY Gray Colormap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

15.27.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

15.27.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

15.28GRID Plot Grid Toggle Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

15.28.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

15.28.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

15.29HCONTOUR Create a contour object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

15.29.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

15.30HIMAGE Create a image object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

15.30.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

15.31HIST Histogram Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

15.31.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

15.32HLINE Create a line object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

15.32.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211


xviii CONTENTS

15.33HOLD Plot Hold Toggle Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

15.33.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

15.33.2 Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

15.33.3 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

15.34HPATCH Create a patch object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

15.34.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

15.35HPOINT Get Point From Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

15.35.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

15.36HRAWPLOT Generate a Raw Plot File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

15.36.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

15.37HSURFACE Create a surface object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

15.37.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

15.38HTEXT Create a text object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

15.38.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

15.39HTEXTBITMAP Get Text Rendered as a Bitmap . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

15.39.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

15.40IMAGE Image Display Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

15.40.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

15.40.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

15.41IMAGEPROPERTIES Image Object Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

15.41.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

15.42IMAGESC Image Display Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

15.42.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

15.42.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

15.43IS2DVIEW Test Axes For 2D View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

15.43.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

15.44ISHOLD Test Hold Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

15.44.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

15.45LEGEND Add Legent to Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

15.45.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

15.46LINE Line Display Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

15.46.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

15.47LINEPROPERTIES Line Series Object Properties . . . . . . . . . . . . . . . . . . . . . . . . . . 223

15.47.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

15.48LOGLOG Log-Log Plot Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

15.48.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

15.48.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

15.49NEWPLOT Get Handle For Next Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

15.49.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

15.50PATCH Patch Graphics Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227


CONTENTS xix

15.50.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

15.50.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

15.51PCOLOR Pseudocolor Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228

15.51.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228

15.52PLOT Plot Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

15.52.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

15.52.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

15.53PLOT3 Plot 3D Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

15.53.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

15.53.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

15.54POINT Get Axis Position From Mouse Click . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

15.54.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

15.55PRINT Print a Figure To A File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

15.55.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

15.55.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

15.56PVALID Validate Property Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

15.56.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

15.56.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

15.57SEMILOGX Semilog X Axis Plot Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

15.57.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

15.57.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

15.58SEMILOGY Semilog Y Axis Plot Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

15.58.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

15.58.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

15.59SET Set Object Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

15.59.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

15.60SIZEFIG Set Size of Figure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

15.60.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

15.61SUBPLOT Subplot Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

15.61.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

15.61.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

15.62SURF Surface Plot Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

15.62.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

15.62.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

15.63SURFACEPROPERTIES Surface Object Properties . . . . . . . . . . . . . . . . . . . . . . . . . 252

15.63.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

15.64TEXT Add Text Label to Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

15.64.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

15.64.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

15.65TEXTPROPERTIES Text Object Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256


xx CONTENTS

15.65.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

15.66TITLE Plot Title Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

15.66.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

15.66.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

15.67TUBEPLOT Creates a Tubeplot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

15.67.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

15.67.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

15.68UICONTROL Create a UI Control object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

15.68.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262

15.69UICONTROLPROPERTIES UI Control Properties . . . . . . . . . . . . . . . . . . . . . . . . . . 263

15.69.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263

15.70VIEW Set Graphical View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

15.70.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

15.70.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

15.71WINLEV Image Window-Level Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

15.71.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

15.71.2 Internals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

15.71.3 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

15.72XLABEL Plot X-axis Label Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

15.72.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

15.72.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

15.73XLIM Adjust X Axis limits of plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271

15.73.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271

15.73.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

15.74YLABEL Plot Y-axis Label Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

15.74.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

15.74.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

15.75YLIM Adjust Y Axis limits of plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

15.75.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

15.75.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278

15.76ZLABEL Plot Z-axis Label Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

15.76.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

15.76.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282

15.77ZLIM Adjust Z Axis limits of plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

15.77.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

15.78ZOOM Image Zoom Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

15.78.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

15.78.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

15.79ZPLANE Zero-pole plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

15.79.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289


CONTENTS xxi

16 Inspection Functions 291

16.1 CLEAR Clear or Delete a Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292

16.1.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292

16.1.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

16.2 END End Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

16.2.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

16.3 EXIST Test for Existence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

16.3.1 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

16.3.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

freemat-4.2

Documents