Next:
Introduction
Up:
FreeMat Help Version 1.10
Previous:
FreeMat Help Version 1.10
Contents
Introduction
Getting Started
Installing FreeMat from Source
Setting up the FreeMat Path
Note on BLAS - Basic Linear Algebra System
Changes from 1.07 to 1.08
Basic Language
Variables and Arrays
STRUCT Structure Array Constructor
STRING String Arrays
MATRIX Matrix Definitions
CELL Cell Array Definitions
GLOBAL Global Variables
PERSISTENT Persistent Variables
INDEXING Indexing Expressions
Functions and Scripts
FUNCTION Function Declarations
KEYWORDS Function Keywords
VARARGIN Variable Input Arguments
VARARGOUT Variable Output Arguments
SCRIPT Script Files
NARGIN Number of Input Arguments
NARGOUT Number of Output Arguments
SPECIAL Special Calling Syntax
Mathematical Operators
PLUS Addition Operator
MINUS Subtraction Operator
DOTTIMES Element-wise Multiplication Operator
DOTRIGHTDIVIDE Element-wise Right-Division Operator
DOTLEFTDIVIDE Element-wise Left-Division Operator
DOTPOWER Element-wise Power Operator
COMPARISONOPS Array Comparison Operators
LOGICALOPS Logical Array Operators
LEFTDIVIDE Matrix Equation Solver/Divide Operator
RIGHTDIVIDE Matrix Equation Solver/Divide Operator
HERMITIAN Matrix Hermitian (Conjugate Transpose) Operator
TRANSPOSE Matrix Transpose Operator
POWER Matrix Power Operator
COLON Index Generation Operator
Flow Control
LASTERR Retrieve Last Error Message
ERROR Causes an Error Condition Raised
TRY-CATCH Try and Catch Statement
SWITCH Switch statement
IF-ELSEIF-ELSE Conditional Statements
WHILE While Loop
FOR For Loop
CONTINUE Continue Execution In Loop
BREAK Exit Execution In Loop
RETURN Return From Function
RETALL Return From All Keyboard Sessions
KEYBOARD Initiate Interactive Debug Session
FreeMat Functions
PCODE Convert a Script or Function to P-Code
TIC Start Stopwatch Timer
TOC Start Stopwatch Timer
HELP Help
SLEEP Sleep For Specified Number of Seconds
EVAL Evaluate a String
SOURCE Execute an Arbitrary File
FEVAL Evaluate a Function
LOADLIB Load Library Function
IMPORT Foreign Function Import
QUIT Quit Program
BIND Bind Standalone Executable
EXIT Exit Program
RESCAN Rescan M Files for Changes
Debugging FreeMat Code
DBAUTO Control Dbauto Functionality
DBDELETE Delete a Breakpoint
DBLIST List Breakpoints
DBSTEP Step N Statements
DBSTOP
Sparse Matrix Support
NNZ Number of Nonzeros
SPARSE Construct a Sparse Matrix
FULL Convert Sparse Matrix to Full Matrix
EIGS Sparse Matrix Eigendecomposition
SPONES Sparse Ones Function
SPEYE Sparse Identity Matrix
SPRAND Sparse Uniform Random Matrix
SPRANDN Sparse Normal Random Matrix
SPY Visualize Sparsity Pattern of a Sparse Matrix
Built In Functions
Mathematical Functions
LOG Natural Logarithm Function
EXP Exponential Function
COS Trigonometric Cosine Function
SIN Trigonometric Sine Function
TAN Trigonometric Tangent Function
CSC Trigonometric Cosecant Function
SEC Trigonometric Secant Function
COT Trigonometric Cotangent Function
ACOS Inverse Trigonometric Arccosine Function
ASIN Inverse Trigonometric Arcsine Function
ATAN Inverse Trigonometric Arctangent Function
ATAN2 Inverse Trigonometric 4-Quadrant Arctangent Function
EXPEI Exponential Weighted Integral Function
EONE Exponential Integral Function
EI Exponential Integral Function
ERFCX Complimentary Weighted Error Function
ERFC Complimentary Error Function
ERF Error Function
DAWSON Dawson Integral Function
PSI Psi Function
GAMMA Gamma Function
GAMMALN Log Gamma Function
IDIV Integer Division Operation
LOG10 Base-10 Logarithm Function
LOG2 Base-2 Logarithm Function
MOD Modulus Operation
SQRT Square Root of an Array
Base Constants
INF Infinity Constant
NAN Not-a-Number Constant
I-J Square Root of Negative One
PI Constant Pi
E Euler Constant (Base of Natural Logarithm)
EPS Double Precision Floating Point Relative Machine Precision Epsilon
FEPS Single Precision Floating Point Relative Machine Precision Epsilon
TEPS Type-based Epsilon Calculation
Elementary Functions
MIN Minimum Function
MAX Maximum Function
CEIL Ceiling Function
FLOOR Floor Function
CUMSUM Cumulative Summation Function
SUM Sum Function
MEAN Mean Function
VAR Variance Function
CONJ Conjugate Function
REAL Real Function
IMAG Imaginary Function
ABS Absolute Value Function
PROD Product Function
STD Standard Deviation Function
Inspection Functions
CLEAR Clear or Delete a Variable
WHO Describe Currently Defined Variables
SIZE Size of a Variable
ISSET Test If Variable Set
EXIST Test for Existence
ISSPARSE Test for Sparse Matrix
ISNAN Test for Not-a-Numbers
ISINF Test for infinities
WHERE Get Information on Program Stack
WHICH Get Information on Function
ISEMPTY Test For Variable Empty
ISA Test Type of Variable
Type Cast Functions
UINT8 Convert to Unsigned 8-bit Integer
UINT16 Convert to Unsigned 16-bit Integer
UINT32 Convert to Unsigned 32-bit Integer
INT8 Convert to Signed 8-bit Integer
INT16 Convert to Signed 16-bit Integer
INT32 Convert to Signed 32-bit Integer
DOUBLE Convert to 64-bit Floating Point
COMPLEX Convert to 32-bit Complex Floating Point
DCOMPLEX Convert to 32-bit Complex Floating Point
TYPEOF Determine the Type of an Argument
Array Generation and Manipulations
INT2BIN Convert Integer Arrays to Binary
BIN2INT Convert Binary Arrays to Integer
UNIQUE Unique
SORT Sort
RESHAPE Reshape Array
ZEROS Array of Zeros
ONES Array of Ones
FIND Find Non-zero Elements of An Array
DIAG Diagonal Matrix Construction/Extraction
REPMAT Array Replication Function
CIRCSHIFT Circularly Shift an Array
EYE Identity Matrix
FLIPDIM Reverse a Matrix Along a Given Dimension
FLIPLR Reverse the Columns of a Matrix
FLIPUD Reverse the Columns of a Matrix
LENGTH Length of and Array
LINSPACE Linearly Spaced Vector
NONZEROS Retrieve Nonzero Matrix Entries
NORM Norm Calculation
NUMEL Number of Elements in an Array
PINV Moore-Penrose Pseudoinverse
RANK Calculate the Rank of a Matrix
RESHAPE Reshape Array
SQUEEZE Remove Singleton Dimensions of an Array
Random Number Generation
SEED Seed the Random Number Generator
RANDBETA Beta Deviate Random Number Generator
RANDI Uniformly Distributed Integer
RANDCHI Generate Chi-Square Random Variable
RANDEXP Generate Exponential Random Variable
RANDP Generate Poisson Random Variable
RANDBIN Generate Binomial Random Variables
RANDNBIN Generate Negative Binomial Random Variables
RANDF Generate F-Distributed Random Variable
RANDGAMMA Generate Gamma-Distributed Random Variable
RANDMULTI Generate Multinomial-distributed Random Variables
RANDNCHI Generate Noncentral Chi-Square Random Variable
RANDNF Generate Noncentral F-Distribution Random Variable
RANDN Gaussian (Normal) Random Number Generator
RAND Uniform Random Number Generator
Input/Ouput Functions
SETPRINTLIMIT Set Limit For Printing Of Arrays
GETPRINTLIMIT Get Limit For Printing Of Arrays
FOPEN File Open Function
FCLOSE File Close Function
FREAD File Read Function
FWRITE File Write Function
FTELL File Position Function
FEOF End Of File Function
FSEEK Seek File To A Given Position
SPRINTF Formated String Output Function (C-Style)
PRINTF Formated Output Function (C-Style)
FGETLINE Read a String from a File
STR2NUM Convert a String to a Number
FSCANF Formatted File Input Function (C-Style)
FPRINTF Formated File Output Function (C-Style)
SAVE Save Variables To A File
LOAD Load Variables From A File
DISP Display a Variable or Expression
GETLINE Get a Line of Input from User
String Functions
STRCMP String Compare Function
Transforms/Decompositions
FFT (Inverse) Fast Fourier Transform Function
LU LU Decomposition for Matrices
EIG Eigendecomposition of a Matrix
QR QR Decomposition of a Matrix
SVD Singular Value Decomposition of a Matrix
Operating System Functions
CD Change Working Directory Function
LS/DIR List Files Function
PWD Print Working Directory Function
GETPATH Get Current Search Path
SETPATH Set Current Search Path
SYSTEM Call an External Program
Optimization and Curve Fitting
INTERPLIN1 Linear 1-D Interpolation
FITFUN Fit a Function
GAUSFIT Gaussian Curve Fit
POLYFIT Fit Polynomial To Data
POLYVAL Evaluate Polynomial Fit at Selected Points
Graphing Functions
Figure Functions
PRINT Print a Figure To A File
SIZEFIG Set Size of an Fig Window
FIGURE Figure Window Select and Create Function
COPY Copy Figure Window
CLOSE Close Figure Window
Image Display Functions
COLORMAP Image Colormap Function
WINLEV Image Window-Level Function
IMAGE Image Display Function
ZOOM Image Zoom Function
POINT Image Point Information Function
COPPER Copper Colormap
GRAY Gray Colormap
Plot Functions
XLABEL Plot X-axis Label Function
YLABEL Plot Y-axis Label Function
LEGEND Add Legend to Plot
TITLE Plot Title Function
GRID Plot Grid Toggle Function
HOLD Plot Hold Toggle Function
PLOT Plot Function
AXIS Plot Axis Set/Get Function
XLIM Adjust X Limits of plot
YLIM Adjust Y Limits of plot
MPI Functions
MPI Functions
MPISEND MPI Send Array
MPIBARRIER MPI Barrier
MPIBCAST MPI Broadcast
MPIRECV MPI Receive Array
MPICOMMRANK MPI Communicator Rank
MPICOMMSIZE MPI Communicator Size
MPIALLREDUCE MPI All Reduce Operation
MPIREDUCE MPI Reduce Operation
MPIINITIALIZED MPI Initialized Test
MPIINIT MPI Initialize
MPICOMMSPAWN MPI Communicator Spawn
MPIINTERCOMMMERGE MPI Intercommunicator Merge
MPICOMMGETPARENT MPI Get Parent Communicator
MPIFINALIZE MPI Finalize
MPIRUN MPI Process Run
MPISERVER MPI Process Server
Samit K. Basu 2005-03-16