Next:
Contents
Contents
FreeMat Help
Version 1.08
Samit Basu
Contents
Introduction
Changes from 1.07 to 1.08
Basic Language
Variables and Arrays
CELL Cell Array Definitions
Usage
Examples
GLOBAL Global Variables
Usage
Example
INDEXING Indexing Expressions
Usage
Array Indexing
Cell Indexing
Structure Indexing
Complex Indexing
MATRIX Matrix Definitions
Usage
Examples
PERSISTENT Persistent Variables
Usage
Example
STRUCT Structure Array Constructor
Usage
Example
Functions and Scripts
FUNCTION Function Declarations
Usage
Examples
KEYWORDS Function Keywords
Usage
Example
NARGIN Number of Input Arguments
Usage
Example
NARGOUT Number of Output Arguments
Usage
Example
SCRIPT Script Files
Usage
Example
SPECIAL Special Calling Syntax
Usage
Example
VARARGIN Variable Input Arguments
Usage
Example
VARARGOUT Variable Output Arguments
Usage
Example
Mathematical Operators
COLON Index Generation Operator
Usage
Examples
COMPARISONOPS Array Comparison Operators
Usage
Examples
DOTLEFTDIVIDE Element-wise Left-Division Operator
Usage
Function Internals
Examples
DOTPOWER Element-wise Power Operator
Usage
Function Internals
Examples
DOTRIGHTDIVIDE Element-wise Right-Division Operator
Usage
Function Internals
Examples
DOTTIMES Element-wise Multiplication Operator
Usage
Function Internals
Examples
HERMITIAN Matrix Hermitian (Conjugate Transpose) Operator
Usage
Function Internals
Examples
LEFTDIVIDE Matrix Equation Solver/Divide Operator
Usage
Function Internals
Examples
LOGICALOPS Logical Array Operators
Usage
Examples
MINUS Subtraction Operator
Usage
Function Internals
Examples
PLUS Addition Operator
Usage
Function Internals
Examples
POWER Matrix Power Operator
Usage
Function Internals
Examples
RIGHTDIVIDE Matrix Equation Solver/Divide Operator
Usage
Function Internals
Examples
TIMES Matrix Multiply Operator
Usage
Function Internals
Examples
TRANSPOSE Matrix Transpose Operator
Usage
Function Internals
Examples
Flow Control
BREAK Exit Execution In Loop
Usage
Example
CONTINUE Continue Execution In Loop
Usage
Example
ERROR Causes an Error Condition Raised
Usage
Example
FOR For Loop
Usage
Examples
IF-ELSEIF-ELSE Conditional Statements
Usage
Examples
KEYBOARD Initiate Interactive Debug Session
Usage
Example
LASTERR Retrieve Last Error Message
Usage
Example
RETALL Return From All Keyboard Sessions
Usage
Example
RETURN Return From Function
Usage
Example
SWITCH Switch statement
Usage
Examples
TRY-CATCH Try and Catch Statement
Usage
Examples
WHILE While Loop
Usage
Examples
FreeMat Functions
EVAL Evaluate a String
Usage
Example
FEVAL Evaluate a Function
Usage
Example
HELP Help
Usage
IMPORT Foreign Function Import
Usage
Example
LOADLIB Load Library Function
Usage
QUIT Quit Program
Usage
SLEEP Sleep For Specified Number of Seconds
Usage
SOURCE Execute an Arbitrary File
Usage
Example
PCODE Convert a Script or Function to P-Code
Usage
Built In Functions
Transcendental Functions
EXP Exponential Function
Usage
Function Internals
Example
LOG Natural Logarithm Function
Usage
Function Internals
Example
Trigonometric/Inverse Trig Functions
ACOS Inverse Trigonometric Arccosine Function
Usage
Function Internals
Example
ASIN Inverse Trigonometric Arcsine Function
Usage
Function Internals
Example
ATAN Inverse Trigonometric Arctangent Function
Usage
Function Internals
Example
ATAN2 Inverse Trigonometric 4-Quadrant Arctangent Function
Usage
Function Internals
Example
COS Trigonometric Cosine Function
Usage
Function Internals
Example
COT Trigonometric Cotangent Function
Usage
Function Internals
Example
CSC Trigonometric Cosecant Function
Usage
Function Internals
Example
SEC Trigonometric Secant Function
Usage
Function Internals
Example
SIN Trigonometric Sine Function
Usage
Function Internals
Example
TAN Trigonometric Tangent Function
Usage
Function Internals
Example
Special Functions
EI Exponential Integral Function
Usage
Function Internals
Example
EONE Exponential Integral Function
Usage
Function Internals
Example
DAWSON Dawson Integral Function
Usage
Function Internals
Example
ERFC Complimentary Error Function
Usage
Function Internals
Example
ERFCX Complimentary Weighted Error Function
Usage
Function Internals
Example
ERF Error Function
Usage
Function Internals
Example
EXPEI Exponential Weighted Integral Function
Usage
Function Internals
Example
GAMMALN Log Gamma Function
Usage
Example
GAMMA Gamma Function
Usage
Function Internals
Example
PSI Psi Function
Usage
Function Internals
Example
Base Constants
E Euler Constant (Base of Natural Logarithm)
Usage
Example
I-J Square Root of Negative One
Usage
Example
INF Infinity Constant
Usage
Function Internals
Example
NAN Not-a-Number Constant
Usage
Example
PI Constant Pi
Usage
Example
EPS Double Precision Floating Point Relative Machine Precision Epsilon
Usage
Example
FEPS Single Precision Floating Point Relative Machine Precision Epsilon
Usage
Example
Statistical Functions
MEAN Mean Function
Usage
Function Internals
Example
VAR Variance Function
Usage
Function Internals
Example
Inspection Functions
CLEAR Clear or Delete a Variable
Usage
Example
EXIST Text Existence of a Variable
Usage
Example
GETPRINTLIMIT Get Limit For Printing Of Arrays
Usage
Example
ISEMPTY Test For Variable Empty
Usage
Examples
SETPRINTLIMIT Set Limit For Printing Of Arrays
Usage
Example
SIZE Size of a Variable
Usage
Example
TYPEOF Determine the Type of an Argument
Usage
Example
WHO Describe Currently Defined Variables
Usage
Example
WHICH Get Information on Function
Usage
Example
WHERE Get Information on Program Stack
Usage
Example
ISINF Test for infinities
Usage
Example
ISNAN Test for Not-a-Numbers
Usage
Example
Type Cast Functions
COMPLEX Convert to 32-bit Complex Floating Point
Usage
Example
DCOMPLEX Convert to 32-bit Complex Floating Point
Usage
Example
DOUBLE Convert to 64-bit Floating Point
Usage
Example
FLOAT Convert to 32-bit Floating Point
Usage
Example
INT16 Convert to Signed 16-bit Integer
Usage
Example
INT32 Convert to Signed 32-bit Integer
Usage
Example
INT8 Convert to Signed 8-bit Integer
Usage
Example
UINT16 Convert to Unsigned 16-bit Integer
Usage
Example
UINT32 Convert to Unsigned 32-bit Integer
Usage
Example
UINT8 Convert to Unsigned 8-bit Integer
Usage
Example
Elementary Functions
ABS Absolute Value Function
Usage
Example
CEIL Ceiling Function
Usage
Example
CONJ Conjugate Function
Usage
Example
CUMSUM Cumulative Summation Function
Usage
Function Internals
Example
FLOOR Floor Function
Usage
Example
IMAG Imaginary Function
Usage
Example
MAX Maximum Function
Usage
Function Internals
Example
MIN Minimum Function
Usage
Function Internals
Example
PROD Product Function
Usage
Example
REAL Real Function
Usage
Example
SUM Sum Function
Usage
Function Internals
Example
Array Generation and Manipulations
DIAG Diagonal Matrix Construction/Extraction
Usage
Examples
FIND Find Non-zero Elements of An Array
Usage
Example
ONES Array of Ones
Usage
Example
RESHAPE Reshape An Array
Usage
Example
ZEROS Array of Zeros
Usage
Example
BIN2INT Convert Binary Arrays to Integer
Usage
Example
INT2BIN Convert Integer Arrays to Binary
Usage
Example
REPMAT Array Replication Function
Usage
Example
Random Number Generation
RAND Uniform Random Number Generator
Usage
Example
RANDN Gaussian (Normal) Random Number Generator
Usage
Function Internals
Example
SEED Seed the Random Number Generator
Usage
Example
RANDBETA Beta Deviate Random Number Generator
Usage
Function Internals
Example
RANDBIN Generate Binomial Random Variables
Usage
Function Internals
Example
RANDCHI Generate Chi-Square Random Variable
Usage
Function Internals
Example
RANDEXP Generate Exponential Random Variable
Usage
Function Internals
Example
RANDF Generate F-Distributed Random Variable
Usage
Function Internals
Example
RANDGAMMA Generate Gamma-Distributed Random Variable
Usage
Function Internals
Example
RANDI Uniformly Distributed Integer
Usage
Example
RANDMULTI Generate Multinomial-distributed Random Variables
Usage
Function Internals
Example
RANDNBIN Generate Negative Binomial Random Variables
Usage
Function Internals
Example
RANDNCHI Generate Noncentral Chi-Square Random Variable
Usage
Function Internals
Examples
RANDNF Generate Noncentral F-Distribution Random Variable
Usage
Function Internals
Example
RANDP Generate Poisson Random Variable
Usage
Function Internals
Example
Input/Ouput Functions
DISP Display a Variable or Expression
Usage
Example
FCLOSE File Close Function
Usage
Example
FEOF End Of File Function
Usage
Example
FGETLINE Read a String from a File
Usage
Example
FOPEN File Open Function
Usage
Examples
FPRINTF Formated File Output Function (C-Style)
Usage
Examples
FREAD File Read Function
Usage
Example
FSCANF Formatted File Input Function (C-Style)
Usage
FSEEK Seek File To A Given Position
Usage
Example
FTELL File Position Function
Usage
Example
FWRITE File Write Function
Usage
Example
LOAD Load Variables From A File
Usage
Example
PRINTF Formated Output Function (C-Style)
Usage
Format of the format string:
The flag characters:
The field width:
The precision:
The conversion specifier:
Example
SAVE Save Variables To A File
Usage
Example
SPRINTF Formated String Output Function (C-Style)
Usage
Examples
String Functions
STRCMP String Compare Function
Usage
Example
STR2NUM Convert a String to a Number
Usage
Transforms/Decompositions
EIG Eigendecomposition of a Matrix
Usage
Function Internals
Example
FFT (Inverse) Fast Fourier Transform Function
Usage
Function Internals
Example
QR QR Decomposition of a Matrix
Usage
SVD Singular Value Decomposition of a Matrix
Usage
Function Internals
Examples
Operating System Functions
CD Change Working Directory Function
Usage
Example
LS/DIR List Files Function
Usage
Example
PWD Print Working Directory Function
Usage
Example
SYSTEM Call an External Program
Usage
Example
GETPATH Get Current Search Path
Usage
SETPATH Set Current Search Path
Usage
Optimization and Curve Fitting
FITFUN Fit a Function
Usage
Graphing Functions
Figure Functions
FIGURE Figure Window Select and Create Function
Usage
COPY Copy Figure Window
Usage
PRINT Print a Figure To A File
Usage
Example
CLOSE Close Figure Window
Usage
SIZEFIG Set Size of an Fig Window
Usage
Image Display Functions
IMAGE Image Display Function
Usage
Example
COLORMAP Image Colormap Function
Usage
Function Internals
Examples
POINT Image Point Information Function
Usage
ZOOM Image Zoom Function
Usage
Example
WINLEV Image Window-Level Function
Usage
Function Internals
Examples
Plot Functions
AXIS Plot Axis Set/Get Function
Usage
Function Internals
Example
GRID Plot Grid Toggle Function
Usage
Example
HOLD Plot Hold Toggle Function
Usage
Function Internals
Example
PLOT Plot Function
Usage
Example
XLABEL Plot X-axis Label Function
Usage
Example
YLABEL Plot Y-axis Label Function
Usage
Example
TITLE Plot Title Function
Usage
Example
LEGEND Add Legend to Plot
Usage
MPI Functions
MPIINIT MPI Initialize
Usage
MPIINITIALIZED MPI Initialized Test
Usage
Example
MPIBARRIER MPI Barrier
Usage
MPIBCAST MPI Broadcast
Usage
MPICOMMGETPARENT MPI Get Parent Communicator
Usage
MPICOMMRANK MPI Communicator Rank
Usage
Example
MPICOMMSIZE MPI Communicator Size
Usage
Example
MPICOMMSPAWN MPI Communicator Spawn
Usage
MPIINTERCOMMMERGE MPI Intercommunicator Merge
Usage
MPISEND MPI Send Array
Usage
Function Internals
Example
MPIRECV MPI Receive Array
Usage
Example
MPIREDUCE MPI Reduce Operation
Usage
MPIFINALIZE MPI Finalize
MPIALLREDUCE MPI All Reduce Operation
Usage
2004-10-09