Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

Functions

Alphabetical List By Category

Language Fundamentals

Entering Commands

ansMost recent answer
clcClear Command Window
diarySave Command Window text to file
formatSet Command Window output display format
homeSend cursor home
iskeywordDetermine whether input is MATLAB keyword
moreControl paged output for Command Window

Matrices and Arrays

zerosCreate array of all zeros
onesCreate array of all ones
randUniformly distributed random numbers
trueLogical 1 (true)
falseLogical 0 (false)
eyeIdentity matrix
diagCreate diagonal matrix or get diagonal elements of matrix
blkdiagConstruct block diagonal matrix from input arguments
catConcatenate arrays along specified dimension
horzcatConcatenate arrays horizontally
vertcatConcatenate arrays vertically
repelemRepeat copies of array elements
repmatRepeat copies of array
linspaceGenerate linearly spaced vector
logspaceGenerate logarithmically spaced vector
freqspaceFrequency spacing for frequency response
meshgrid2-D and 3-D grids
ndgridRectangular grid in N-D space
lengthLength of largest array dimension
sizeArray size
ndimsNumber of array dimensions
numelNumber of array elements
isscalarDetermine whether input is scalar
isvectorDetermine whether input is vector
ismatrixDetermine whether input is matrix
isrowDetermine whether input is row vector
iscolumnDetermine whether input is column vector
isemptyDetermine whether array is empty
sortSort array elements
sortrowsSort rows of matrix or table
issortedDetermine if array is sorted
issortedrowsDetermine if matrix or table rows are sorted
topkrowsTop rows in sorted order
flipFlip order of elements
fliplrFlip array left to right
flipudFlip array up to down
rot90Rotate array 90 degrees
transposeTranspose vector or matrix
ctransposeComplex conjugate transpose
permuteRearrange dimensions of N-D array
ipermuteInverse permute dimensions of N-D array
circshiftShift array circularly
shiftdimShift dimensions
reshapeReshape array
squeezeRemove singleton dimensions
colonVector creation, array subscripting, and for-loop iteration
endTerminate block of code, or indicate last array index
ind2subSubscripts from linear index
sub2indConvert subscripts to linear indices

Operators and Elementary Operations

Arithmetic

plusAddition
uplusUnary plus
minusSubtraction
uminusUnary minus
timesElement-wise multiplication
rdivideRight array division
ldivideLeft array division
powerElement-wise power
mtimesMatrix Multiplication
mrdivideSolve systems of linear equations xA = B for x
mldivideSolve systems of linear equations Ax = B for x
mpowerMatrix power
cumprodCumulative product
cumsumCumulative sum
diffDifferences and Approximate Derivatives
movsumMoving sum
prodProduct of array elements
sumSum of array elements
ceilRound toward positive infinity
fixRound toward zero
floorRound toward negative infinity
idivideInteger division with rounding option
modRemainder after division (modulo operation)
remRemainder after division
roundRound to nearest decimal or integer
bsxfunApply element-wise operation to two arrays with implicit expansion enabled

Relational Operations

eqDetermine equality
geDetermine greater than or equal to
gtDetermine greater than
leDetermine less than or equal to
ltDetermine less than
neDetermine inequality
isequalDetermine array equality
isequalnDetermine array equality, treating NaN values as equal

Logical Operations

Logical Operators: Short-circuitLogical operations with short-circuiting
andFind logical AND
notFind logical NOT
orFind logical OR
xorFind logical exclusive-OR
allDetermine if all array elements are nonzero or true
anyDetermine if any array elements are nonzero
falseLogical 0 (false)
findFind indices and values of nonzero elements
islogicalDetermine if input is logical array
logicalConvert numeric values to logicals
trueLogical 1 (true)

Set Operations

intersectSet intersection of two arrays
ismemberArray elements that are members of set array
ismembertolMembers of set within tolerance
issortedDetermine if array is sorted
setdiffSet difference of two arrays
setxorSet exclusive OR of two arrays
unionSet union of two arrays
uniqueUnique values in array
uniquetolUnique values within tolerance
joinCombine two tables or timetables by rows using key variables
innerjoinInner join between two tables or timetables
outerjoinOuter join between two tables or timetables

Bit-Wise Operations

bitandBit-wise AND
bitcmpBit-wise complement
bitgetGet bit at specified position
bitorBit-wise OR
bitsetSet bit at specific location
bitshiftShift bits specified number of places
bitxorBit-wise XOR
swapbytesSwap byte ordering

Data Types

Numeric Types

doubleDouble-precision arrays
singleSingle-precision arrays
int88-bit signed integer arrays
int1616-bit signed integer arrays
int3232-bit signed integer arrays
int6464-bit signed integer arrays
uint88-bit unsigned integer arrays
uint1616-bit unsigned integer arrays
uint3232-bit unsigned integer arrays
uint6464-bit unsigned integer arrays
castCast variable to different data type
typecastConvert data types without changing underlying data
isintegerDetermine if input is integer array
isfloatDetermine if input is floating-point array
isnumericDetermine if input is numeric array
isrealDetermine whether array is real
isfiniteArray elements that are finite
isinfArray elements that are infinite
isnanArray elements that are NaN
epsFloating-point relative accuracy
flintmaxLargest consecutive integer in floating-point format
InfInfinity
intmaxLargest value of specified integer type
intminSmallest value of specified integer type
NaNNot-a-Number
realmaxLargest positive floating-point number
realminSmallest positive normalized floating-point number

Characters and Strings

stringString array
stringsCreate array of strings with no characters
joinCombine strings
charCharacter array
cellstrConvert to cell array of character vectors
blanksCreate character array of blanks
newlineCreate newline character
composeConvert data into formatted string array
sprintfFormat data into string
strcatConcatenate strings horizontally
convertCharsToStringsConvert character arrays to string arrays, leaving other arrays unaltered
convertStringsToCharsConvert string arrays to character arrays, leaving other arrays unaltered
ischarDetermine if input is character array
iscellstrDetermine if input is cell array of character vectors
isstringDetermine if input is string array
isStringScalar Determine if input is string array with one element
strlengthLength of strings in string array
isstrpropDetermine if string is of specified category
isletterDetermine which character array elements are letters
isspaceDetermine which character array elements are space characters
containsDetermine if pattern is in string
countCount occurrences of pattern in string
endsWithDetermine if string ends with pattern
startsWithDetermine if string starts with pattern
strfindFind one string within another
sscanfRead formatted data from string
replaceFind and replace substrings in string array
replaceBetweenReplace substrings identified by indicators that mark their starts and ends
strrepFind and replace substring
joinCombine strings
splitSplit strings in string array
splitlinesSplit string at newline characters
strjoinJoin text in array
strsplitSplit string at specified delimiter
strtokSelected parts of string
eraseDelete substrings within strings
eraseBetweenDelete substrings between indicators that mark starts and ends of substrings
extractAfterExtract substring after specified position
extractBeforeExtract substring before specified position
extractBetweenExtract substrings between indicators that mark starts and ends of substrings
insertAfterInsert string after specified substring
insertBeforeInsert string before specified substring
padAdd leading or trailing characters to strings
stripRemove leading and trailing characters from string
lowerConvert string to lowercase
upperConvert string to uppercase
reverseReverse order of characters in string
deblankRemove trailing whitespace from end of string or character array
strtrimRemove leading and trailing whitespace from string array or character array
strjustJustify string or character array
strcmpCompare strings
strcmpiCompare strings (case insensitive)
strncmpCompare first n characters of strings (case sensitive)
strncmpiCompare first n characters of strings (case insensitive)
regexpMatch regular expression (case sensitive)
regexpiMatch regular expression (case insensitive)
regexprepReplace text using regular expression
regexptranslateTranslate text into regular expression

Dates and Time

datetimeArrays that represent points in time
NaTNot-a-Time
yearsDuration in years
daysDuration in days
hoursDuration in hours
minutesDuration in minutes
secondsDuration in seconds
millisecondsDuration in milliseconds
durationLengths of time in fixed-length time units
calyearsCalendar duration in years
calquartersCalendar duration in quarters
calmonthsCalendar duration in months
calweeksCalendar duration in weeks
caldaysCalendar duration in days
calendarDurationLengths of time in variable-length calendar units
yearYear number
quarterQuarter number
monthMonth number and name
weekWeek number
dayDay number or name
hourHour number
minuteMinute number
secondSecond number
ymdYear, month, and day numbers of datetime
hmsHour, minute, and second numbers of duration
splitSplit calendar duration into numeric and duration units
timeConvert time of calendar duration to duration
timeofdayElapsed time since midnight for datetimes
isdatetimeDetermine if input is datetime array
isdurationDetermine if input is duration array
iscalendardurationDetermine if input is calendar duration array
isnatDetermine NaT (Not-a-Time) elements
isdstDetermine daylight saving time elements
isweekendDetermine weekend elements
timezonesList time zones
tzoffsetTime zone offset from UTC
betweenCalendar math differences
caldiffCalendar math successive differences
dateshiftShift date or generate sequence of dates and time
isbetweenDetermine elements within date and time interval
datenumConvert date and time to serial date number
datevecConvert date and time to vector of components
exceltimeConvert MATLAB datetime to Excel date number
juliandateConvert MATLAB datetime to Julian date
posixtimeConvert MATLAB datetime to POSIX time
yyyymmddConvert MATLAB datetime to YYYYMMDD numeric value
addtodateModify date number by field
charCharacter array
stringString array
datestrConvert date and time to string format
nowCurrent date and time as serial date number
clockCurrent date and time as date vector
dateCurrent date string
calendarCalendar for specified month
eomdayLast day of month
weekdayDay of week
etimeTime elapsed between date vectors

Categorical Arrays

categoricalArray that contains values assigned to categories
iscategoricalDetermine whether input is categorical array
discretizeGroup data into bins or categories
categoriesCategories of categorical array
iscategoryTest for categorical array categories
isordinalDetermine whether input is ordinal categorical array
isprotectedDetermine whether categories of categorical array are protected
addcatsAdd categories to categorical array
mergecatsMerge categories in categorical array
removecatsRemove categories from categorical array
renamecatsRename categories in categorical array
reordercatsReorder categories in categorical array
setcatsSet categories in categorical array
summaryPrint summary of table, timetable, or categorical array
countcatsCount occurrences of categorical array elements by category
isundefinedFind undefined elements in categorical array

Tables

tableTable array with named variables that can contain different types
array2tableConvert homogeneous array to table
cell2tableConvert cell array to table
struct2tableConvert structure array to table
table2arrayConvert table to homogeneous array
table2cellConvert table to cell array
table2structConvert table to structure array
readtableCreate table from file
writetableWrite table to file
detectImportOptionsCreate import options based on file content
getvaroptsGet variable import options
setvaroptsSet variable import options
setvartypeSet variable data types
istableDetermine whether input is table
headGet top rows of table, timetable, or tall array
tailGet bottom rows of table, timetable, or tall array
heightNumber of table rows
widthNumber of table variables
summaryPrint summary of table, timetable, or categorical array
intersectSet intersection of two arrays
ismemberArray elements that are members of set array
setdiffSet difference of two arrays
setxorSet exclusive OR of two arrays
uniqueUnique values in array
unionSet union of two arrays
joinCombine two tables or timetables by rows using key variables
innerjoinInner join between two tables or timetables
outerjoinOuter join between two tables or timetables
sortrowsSort rows of matrix or table
issortedrowsDetermine if matrix or table rows are sorted
topkrowsTop rows in sorted order
stackStack data from multiple variables into single variable
unstackUnstack data from single variable into multiple variables
vartypeSubscript into table or timetable by variable type
ismissingFind missing values
standardizeMissingInsert standard missing values
rmmissingRemove missing entries
fillmissingFill missing values
varfunApply function to table or timetable variables
rowfunApply function to table or timetable rows
findgroupsFind groups and return group numbers
splitapplySplit data into groups and apply function

Timetables

timetableTimetable array with time-stamped rows and variables of different types
retimeResample or aggregate data in timetable, and resolve duplicate or irregular times
synchronizeSynchronize timetables to common time vector, and resample or aggregate data from input timetables
lagTime-shift data in timetable
table2timetableConvert table to timetable
array2timetableConvert array to timetable
timetable2tableConvert timetable to table
istimetableDetermine if input is timetable
isregularDetermine whether times in timetable are regular
timerangeTime range for timetable row subscripting
withtolTime tolerance for timetable row subscripting
vartypeSubscript into table or timetable by variable type
rmmissingRemove missing entries
issortedDetermine if array is sorted
sortrowsSort rows of matrix or table
uniqueUnique values in array

Structures

structStructure array
fieldnamesField names of structure, or public fields of COM or Java object
getfieldField of structure array
isfieldDetermine whether input is structure array field
isstructDetermine whether input is structure array
orderfieldsOrder fields of structure array
rmfieldRemove fields from structure
setfieldAssign values to structure array field
arrayfunApply function to each element of array
structfunApply function to each field of scalar structure
table2structConvert table to structure array
struct2tableConvert structure array to table
cell2structConvert cell array to structure array
struct2cellConvert structure to cell array

Cell Arrays

cellCell array
cell2matConvert cell array to ordinary array of the underlying data type
cell2structConvert cell array to structure array
cell2tableConvert cell array to table
celldispDisplay cell array contents
cellfunApply function to each cell in cell array
cellplotGraphically display structure of cell array
cellstrConvert to cell array of character vectors
iscellDetermine whether input is cell array
iscellstrDetermine if input is cell array of character vectors
mat2cellConvert array to cell array with potentially different sized cells
num2cellConvert array to cell array with consistently sized cells
strjoinJoin text in array
strsplitSplit string at specified delimiter
struct2cellConvert structure to cell array
table2cellConvert table to cell array

Function Handles

fevalEvaluate function
func2strConstruct character vector from function handle
str2funcConstruct function handle from character vector
localfunctionsFunction handles to all local functions in MATLAB file
functionsInformation about function handle

Map Containers

containers.MapMap values to unique keys
isKeyDetermine if containers.Map object contains key
keysIdentify keys of containers.Map object
removeRemove key-value pairs from containers.Map object
valuesIdentify values in containers.Map object

Time Series

Time Series Basics
appendConcatenate time series objects in time dimension
getQuery timeseries object property values
getdatasamplesizeSize of data sample in timeseries object
getqualitydescData quality descriptions
getsamplesSubset of time series samples using subscripted index array
plotPlot time series
setSet properties of timeseries object
tsdata.eventConstruct event object for timeseries object
timeseriesCreate timeseries object
Data Manipulation
addsampleAdd data sample to timeseries object
delsampleRemove sample from timeseries object
detrendSubtract mean or best-fit line and all NaNs from timeseries object
filterShape frequency content of time-series
getabstimeExtract date-string time vector into cell array
getdatasamplesReturns subset of time series samples using subscripted index array
getinterpmethodInterpolation method for timeseries object
getsampleusingtimeExtract data samples into new timeseries object
idealfilterApply ideal (noncausal) filter to timeseries object
resampleSelect or interpolate timeseries data using new time vector
setabstimeSet times of timeseries object as date strings
setinterpmethodSet default interpolation method for timeseries object
setuniformtimeModify uniform time vector of timeseries object
synchronizeSynchronize and resample two timeseries objects using common time vector
Event Data
addeventAdd event to timeseries object
deleventRemove tsdata.event objects from timeseries object
gettsafterateventNew timeseries object with samples occurring at or after event
gettsaftereventNew timeseries object with samples occurring after event
gettsateventNew timeseries object with samples occurring at event
gettsbeforeateventNew timeseries object with samples occurring before or at event
gettsbeforeeventNew timeseries object with samples occurring before event
gettsbetweeneventsNew timeseries object with samples occurring between events
Descriptive Statistics
iqrInterquartile range of timeseries data
maxMaximum value of timeseries data
meanMean value of timeseries data
medianMedian value of timeseries data
minMinimum value of timeseries data
stdStandard deviation of timeseries data
sumSum of timeseries data
varVariance of timeseries data
Time Series Collections
get (tscollection)Query tscollection object property values
isempty (tscollection)Determine whether tscollection object is empty
length (tscollection)Length of time vector
plotPlot time series
set (tscollection)Set properties of tscollection object
size (tscollection)Size of tscollection object
tscollectionCreate tscollection object
addsampletocollectionAdd sample to tscollection object
addtsAdd timeseries object to tscollection object
delsamplefromcollectionRemove sample from tscollection object
getabstime (tscollection)Extract date-string time vector into cell array
getsampleusingtime (tscollection)Extract data samples into new tscollection object
gettimeseriesnamesCell array of names of timeseries objects in tscollection object
horzcat (tscollection)Horizontal concatenation for tscollection objects
removetsRemove timeseries objects from tscollection object
resample (tscollection)Select or interpolate data in tscollection using new time vector
setabstime (tscollection)Set times of tscollection object as date strings
settimeseriesnamesChange name of timeseries object in tscollection
vertcat (tscollection)Vertical concatenation for tscollection objects

Data Type Identification

iscalendardurationDetermine if input is calendar duration array
iscategoricalDetermine whether input is categorical array
iscellDetermine whether input is cell array
iscellstrDetermine if input is cell array of character vectors
ischarDetermine if input is character array
isdatetimeDetermine if input is datetime array
isdurationDetermine if input is duration array
isenumDetermine if variable is enumeration
isfloatDetermine if input is floating-point array
isgraphicsTrue for valid graphics object handles
isintegerDetermine if input is integer array
isjavaDetermine if input is Java object
islogicalDetermine if input is logical array
isnumericDetermine if input is numeric array
isobjectDetermine if input is MATLAB object
isrealDetermine whether array is real
isstringDetermine if input is string array
isstructDetermine whether input is structure array
istableDetermine whether input is table
istimetableDetermine if input is timetable
is*Detect state
isaDetermine if input is object of specified class
classDetermine class of object
validateattributesCheck validity of array
whosList variables in workspace, with sizes and types

Data Type Conversion

charCharacter array
cellstrConvert to cell array of character vectors
int2strConvert integers to characters
mat2strConvert matrix to characters
num2strConvert numbers to character array
str2doubleConvert string to double precision value
str2numConvert character array to numeric array
native2unicodeConvert numeric bytes to Unicode character representation
unicode2nativeConvert Unicode character representation to numeric bytes
base2decConvert text representing number in base N to decimal number
bin2decConvert text representation of binary number to decimal number
dec2baseConvert decimal number to character vector representing base N number
dec2binConvert decimal number to character vector representing binary number
dec2hexConvert decimal number to character vector representing hexadecimal number
hex2decConvert text representation of hexadecimal number to decimal number
hex2numConvert IEEE hexadecimal string to double-precision number
num2hexConvert singles and doubles to IEEE hexadecimal strings
table2arrayConvert table to homogeneous array
table2cellConvert table to cell array
table2structConvert table to structure array
array2tableConvert homogeneous array to table
cell2tableConvert cell array to table
struct2tableConvert structure array to table
cell2matConvert cell array to ordinary array of the underlying data type
cell2structConvert cell array to structure array
mat2cellConvert array to cell array with potentially different sized cells
num2cellConvert array to cell array with consistently sized cells
struct2cellConvert structure to cell array

Mathematics

Elementary Math

Arithmetic

plusAddition
uplusUnary plus
minusSubtraction
uminusUnary minus
timesElement-wise multiplication
rdivideRight array division
ldivideLeft array division
powerElement-wise power
mtimesMatrix Multiplication
mrdivideSolve systems of linear equations xA = B for x
mldivideSolve systems of linear equations Ax = B for x
mpowerMatrix power
cumprodCumulative product
cumsumCumulative sum
diffDifferences and Approximate Derivatives
movsumMoving sum
prodProduct of array elements
sumSum of array elements
ceilRound toward positive infinity
fixRound toward zero
floorRound toward negative infinity
idivideInteger division with rounding option
modRemainder after division (modulo operation)
remRemainder after division
roundRound to nearest decimal or integer
bsxfunApply element-wise operation to two arrays with implicit expansion enabled

Trigonometry

sinSine of argument in radians
sindSine of argument in degrees
asinInverse sine in radians
asindInverse sine in degrees
sinhHyperbolic sine of argument in radians
asinhInverse hyperbolic sine
cosCosine of argument in radians
cosdCosine of argument in degrees
acosInverse cosine in radians
acosdInverse cosine in degrees
coshHyperbolic cosine
acoshInverse hyperbolic cosine
tanTangent of argument in radians
tandTangent of argument in degrees
atanInverse tangent in radians
atandInverse tangent in degrees
atan2Four-quadrant inverse tangent
atan2dFour-quadrant inverse tangent in degrees
tanhHyperbolic tangent
atanhInverse hyperbolic tangent
cscCosecant of input angle in radians
cscdCosecant of argument in degrees
acscInverse cosecant in radians
acscdInverse cosecant in degrees
cschHyperbolic cosecant
acschInverse hyperbolic cosecant
secSecant of angle in radians
secdSecant of argument in degrees
asecInverse secant in radians
asecdInverse secant in degrees
sechHyperbolic secant
asechInverse hyperbolic secant
cotCotangent of angle in radians
cotdCotangent of argument in degrees
acotInverse cotangent in radians
acotdInverse cotangent in degrees
cothHyperbolic cotangent
acothInverse hyperbolic cotangent
hypotSquare root of sum of squares (hypotenuse)
deg2radConvert angle from degrees to radians
rad2degConvert angle from radians to degrees

Exponents and Logarithms

expExponential
expm1Compute exp(x)-1 accurately for small values of x
logNatural logarithm
log10Common logarithm (base 10)
log1pCompute log(1+x) accurately for small values of x
log2Base 2 logarithm and floating-point number dissection
nextpow2Exponent of next higher power of 2
nthrootReal nth root of real numbers
pow2Base 2 power and scale floating-point numbers
reallogNatural logarithm for nonnegative real arrays
realpowArray power for real-only output
realsqrtSquareroot for nonnegative real arrays
sqrtSquare root

Complex Numbers

absAbsolute value and complex magnitude
anglePhase angle
complexCreate complex array
conjComplex conjugate
cplxpairSort complex numbers into complex conjugate pairs
iImaginary unit
imagImaginary part of complex number
isrealDetermine whether array is real
jImaginary unit
realReal part of complex number
signSign function (signum function)
unwrapCorrect phase angles to produce smoother phase plots

Discrete Math

factorPrime factors
factorialFactorial of input
gcdGreatest common divisor
isprimeDetermine which array elements are prime
lcmLeast common multiple
nchoosekBinomial coefficient or all combinations
permsAll possible permutations
primesPrime numbers less than or equal to input value
ratRational fraction approximation
ratsRational output

Polynomials

polyPolynomial with specified roots or characteristic polynomial
polyeigPolynomial eigenvalue problem
polyfitPolynomial curve fitting
residuePartial fraction expansion (partial fraction decomposition)
rootsPolynomial roots
polyvalPolynomial evaluation
polyvalmMatrix polynomial evaluation
convConvolution and polynomial multiplication
deconvDeconvolution and polynomial division
polyintPolynomial integration
polyderPolynomial differentiation

Special Functions

airyAiry Functions
besselhBessel function of third kind (Hankel function)
besseliModified Bessel function of first kind
besseljBessel function of first kind
besselkModified Bessel function of second kind
besselyBessel function of second kind
betaBeta function
betaincIncomplete beta function
betaincinvBeta inverse cumulative distribution function
betalnLogarithm of beta function
ellipjJacobi elliptic functions
ellipkeComplete elliptic integrals of first and second kind
erfError function
erfcComplementary error function
erfcinvInverse complementary error function
erfcxScaled complementary error function
erfinvInverse error function
expintExponential integral
gammaGamma function
gammaincIncomplete gamma function
gammaincinvInverse incomplete gamma function
gammalnLogarithm of gamma function
legendreAssociated Legendre functions
psiPsi (polygamma) function

Cartesian Coordinate System Conversion

cart2polTransform Cartesian coordinates to polar or cylindrical
cart2sphTransform Cartesian coordinates to spherical
pol2cartTransform polar or cylindrical coordinates to Cartesian
sph2cartTransform spherical coordinates to Cartesian

Constants and Test Matrices

epsFloating-point relative accuracy
flintmaxLargest consecutive integer in floating-point format
iImaginary unit
jImaginary unit
InfInfinity
piRatio of circle's circumference to its diameter
NaNNot-a-Number
isfiniteArray elements that are finite
isinfArray elements that are infinite
isnanArray elements that are NaN
companCompanion matrix
galleryTest matrices
hadamardHadamard matrix
hankelHankel matrix
hilbHilbert matrix
invhilbInverse of Hilbert matrix
magicMagic square
pascalPascal matrix
rosserClassic symmetric eigenvalue test problem
toeplitzToeplitz matrix
vanderVandermonde matrix
wilkinsonWilkinson's eigenvalue test matrix

Linear Algebra

mldivideSolve systems of linear equations Ax = B for x
mrdivideSolve systems of linear equations xA = B for x
decompositionMatrix decomposition for solving linear systems
lsqminnormMinimum norm least-squares solution to linear equation
linsolveSolve linear system of equations
invMatrix inverse
pinvMoore-Penrose pseudoinverse
lscovLeast-squares solution in presence of known covariance
lsqnonnegSolve nonnegative linear least-squares problem
sylvesterSolve Sylvester equation AX + XB = C for X
eigEigenvalues and eigenvectors
eigsSubset of eigenvalues and eigenvectors
balanceDiagonal scaling to improve eigenvalue accuracy
svdSingular value decomposition
svdsSubset of singular values and vectors
gsvdGeneralized singular value decomposition
ordeigEigenvalues of quasitriangular matrices
ordqzReorder eigenvalues in QZ factorization
ordschurReorder eigenvalues in Schur factorization
polyeigPolynomial eigenvalue problem
qzQZ factorization for generalized eigenvalues
hessHessenberg form of matrix
schurSchur decomposition
rsf2csfConvert real Schur form to complex Schur form
cdf2rdfConvert complex diagonal form to real block diagonal form
luLU matrix factorization
ldlBlock LDL' factorization for Hermitian indefinite matrices
cholCholesky factorization
cholupdateRank 1 update to Cholesky factorization
qrOrthogonal-triangular decomposition
qrdeleteRemove column or row from QR factorization
qrinsertInsert column or row into QR factorization
qrupdateRank 1 update to QR factorization
planerotGivens plane rotation
transposeTranspose vector or matrix
ctransposeComplex conjugate transpose
mtimesMatrix Multiplication
mpowerMatrix power
sqrtmMatrix square root
expmMatrix exponential
logmMatrix logarithm
funmEvaluate general matrix function
kronKronecker tensor product
crossCross product
dotDot product
bandwidthLower and upper matrix bandwidth
trilLower triangular part of matrix
triuUpper triangular part of matrix
isbandedDetermine if matrix is within specific bandwidth
isdiagDetermine if matrix is diagonal
ishermitianDetermine if matrix is Hermitian or skew-Hermitian
issymmetricDetermine if matrix is symmetric or skew-symmetric
istrilDetermine if matrix is lower triangular
istriuDetermine if matrix is upper triangular
normVector and matrix norms
normest2-norm estimate
vecnormVector-wise norm
condCondition number with respect to inversion
condest1-norm condition number estimate
rcondReciprocal condition number
condeigCondition number with respect to eigenvalues
detMatrix determinant
nullNull space
orthOrthonormal basis for range of matrix
rankRank of matrix
rrefReduced row echelon form (Gauss-Jordan elimination)
traceSum of diagonal elements
subspaceAngle between two subspaces

Random Number Generation

randUniformly distributed random numbers
randnNormally distributed random numbers
randiUniformly distributed pseudorandom integers
randpermRandom permutation
rngControl random number generation
RandStreamRandom number stream

Interpolation

interp11-D data interpolation (table lookup)
interp2Interpolation for 2-D gridded data in meshgrid format
interp3Interpolation for 3-D gridded data in meshgrid format
interpnInterpolation for 1-D, 2-D, 3-D, and N-D gridded data in ndgrid format
griddedInterpolantGridded data interpolation
pchipPiecewise Cubic Hermite Interpolating Polynomial (PCHIP)
splineCubic spline data interpolation
ppvalEvaluate piecewise polynomial
mkppMake piecewise polynomial
unmkppExtract piecewise polynomial details
padecoefPadé approximation of time delays
interpft1-D interpolation (FFT method)
ndgridRectangular grid in N-D space
meshgrid2-D and 3-D grids
griddataInterpolate 2-D or 3-D scattered data
griddatanInterpolate N-D scattered data
scatteredInterpolantInterpolate 2-D or 3-D scattered data

Optimization

fminbndFind minimum of single-variable function on fixed interval
fminsearchFind minimum of unconstrained multivariable function using derivative-free method
lsqnonnegSolve nonnegative linear least-squares problem
fzeroRoot of nonlinear function
optimgetOptimization options values
optimsetCreate or edit optimization options structure

Numerical Integration and Differential Equations

Ordinary Differential Equations

ode45Solve nonstiff differential equations — medium order method
ode23Solve nonstiff differential equations — low order method
ode113Solve nonstiff differential equations — variable order method
ode15sSolve stiff differential equations and DAEs — variable order method
ode23sSolve stiff differential equations — low order method
ode23tSolve moderately stiff ODEs and DAEs — trapezoidal rule
ode23tbSolve stiff differential equations — trapezoidal rule + backward differentiation formula
ode15iSolve fully implicit differential equations — variable order method
decicCompute consistent initial conditions for ode15i
odegetExtract ODE option values
odesetCreate or modify options structure for ODE solvers
devalEvaluate differential equation solution structure
odextendExtend solution to ODE

Boundary Value Problems

bvp4cSolve boundary value problems for ordinary differential equations
bvp5cSolve boundary value problems for ordinary differential equations
bvpinitForm initial guess for BVP solvers
bvpxtendForm guess structure for extending boundary value solutions
bvpgetExtract properties from options structure created with bvpset
bvpsetCreate or alter options structure of boundary value problem
devalEvaluate differential equation solution structure

Delay Differential Equations

dde23Solve delay differential equations (DDEs) with constant delays
ddesdSolve delay differential equations (DDEs) with general delays
ddensdSolve delay differential equations (DDEs) of neutral type
ddegetExtract properties from delay differential equations options structure
ddesetCreate or alter delay differential equations options structure
devalEvaluate differential equation solution structure

Partial Differential Equations

pdepeSolve initial-boundary value problems for parabolic-elliptic PDEs in 1-D
pdevalEvaluate numerical solution of PDE using output of pdepe

Numerical Integration and Differentiation

integralNumerical integration
integral2Numerically evaluate double integral
integral3Numerically evaluate triple integral
quadgkNumerically evaluate integral, adaptive Gauss-Kronrod quadrature
quad2dNumerically evaluate double integral, tiled method
cumtrapzCumulative trapezoidal numerical integration
trapzTrapezoidal numerical integration
polyintPolynomial integration
del2Discrete Laplacian
diffDifferences and Approximate Derivatives
gradientNumerical gradient
polyderPolynomial differentiation

Fourier Analysis and Filtering

fftFast Fourier transform
fft22-D fast Fourier transform
fftnN-D fast Fourier transform
fftshiftShift zero-frequency component to center of spectrum
fftwDefine method for determining FFT algorithm
ifftInverse fast Fourier transform
ifft22-D inverse fast Fourier transform
ifftnMultidimensional inverse fast Fourier transform
ifftshiftInverse zero-frequency shift
nextpow2Exponent of next higher power of 2
interpft1-D interpolation (FFT method)
convConvolution and polynomial multiplication
conv22-D convolution
convnN-D convolution
deconvDeconvolution and polynomial division
filter1-D digital filter
filter22-D digital filter
ss2tfConvert state-space representation to transfer function
padecoefPadé approximation of time delays

Sparse Matrices

spallocAllocate space for sparse matrix
spdiagsExtract and create sparse band and diagonal matrices
speyeSparse identity matrix
sprandSparse uniformly distributed random matrix
sprandnSparse normally distributed random matrix
sprandsymSparse symmetric random matrix
sparseCreate sparse matrix
spconvertImport from sparse matrix external format
issparseDetermine whether input is sparse
nnzNumber of nonzero matrix elements
nonzerosNonzero matrix elements
nzmaxAmount of storage allocated for nonzero matrix elements
spfunApply function to nonzero sparse matrix elements
sponesReplace nonzero sparse matrix elements with ones
spparmsSet parameters for sparse matrix routines
spyVisualize sparsity pattern
findFind indices and values of nonzero elements
fullConvert sparse matrix to full matrix
dissectNested dissection permutation
amdApproximate minimum degree permutation
colamdColumn approximate minimum degree permutation
colpermSparse column permutation based on nonzero count
dmpermDulmage-Mendelsohn decomposition
randpermRandom permutation
symamdSymmetric approximate minimum degree permutation
symrcmSparse reverse Cuthill-McKee ordering
pcgPreconditioned conjugate gradients method
minresMinimum residual method
symmlqSymmetric LQ method
gmresGeneralized minimum residual method (with restarts)
bicgBiconjugate gradients method
bicgstabBiconjugate gradients stabilized method
bicgstablBiconjugate gradients stabilized (l) method
cgsConjugate gradients squared method
qmrQuasi-minimal residual method
tfqmrTranspose-free quasi-minimal residual method
lsqrLSQR method
ichol Incomplete Cholesky factorization
iluIncomplete LU factorization
eigsSubset of eigenvalues and eigenvectors
svdsSubset of singular values and vectors
normest2-norm estimate
condest1-norm condition number estimate
sprankStructural rank
etreeElimination tree
symbfactSymbolic factorization analysis
spaugmentForm least squares augmented system
dmpermDulmage-Mendelsohn decomposition
etreeplotPlot elimination tree
treelayoutLay out tree or forest
treeplotPlot picture of tree
gplotPlot nodes and links representing adjacency matrix
unmeshConvert edge matrix to coordinate and Laplacian matrices

Graph and Network Algorithms

graphGraph with undirected edges
digraphGraph with directed edges
addnodeAdd new node to graph
rmnodeRemove node from graph
addedgeAdd new edge to graph
rmedgeRemove edge from graph
flipedgeReverse edge directions
numnodesNumber of nodes in graph
numedgesNumber of edges in graph
findnodeLocate node in graph
findedgeLocate edge in graph
reordernodesReorder graph nodes
subgraphExtract subgraph
bfsearchBreadth-first graph search
dfsearchDepth-first graph search
centralityMeasure node importance
maxflowMaximum flow in graph
conncompConnected graph components
biconncompBiconnected graph components
condensationGraph condensation
bctreeBlock-cut tree graph
minspantreeMinimum spanning tree of graph
toposortTopological order of directed acyclic graph
isdagDetermine if graph is acyclic
transclosureTransitive closure
transreductionTransitive reduction
isisomorphicDetermine whether two graphs are isomorphic
isomorphismCompute equivalence relation between two graphs
shortestpathShortest path between two single nodes
shortestpathtreeShortest path tree from node
distancesShortest path distances of all node pairs
adjacencyGraph adjacency matrix
incidenceGraph incidence matrix
laplacianGraph Laplacian matrix
degreeDegree of graph nodes
neighborsNeighbors of graph node
nearestNearest neighbors within radius
indegreeIn-degree of nodes
outdegreeOut-degree of nodes
predecessorsNode predecessors
successorsNode successors
plotPlot graph nodes and edges
labeledgeLabel graph edges
labelnodeLabel graph nodes
layoutChange layout of graph plot
highlightHighlight nodes and edges in plotted graph
GraphPlotGraph plot for directed and undirected graphs

Computational Geometry

Triangulation Representation

triangulationTriangulation in 2-D or 3-D
tetrameshTetrahedron mesh plot
trimeshTriangular mesh plot
triplot2-D triangular plot
trisurfTriangular surface plot

Delaunay Triangulation

delaunayTriangulationDelaunay triangulation in 2-D and 3-D
delaunayDelaunay triangulation
delaunaynN-D Delaunay triangulation
tetrameshTetrahedron mesh plot
trimeshTriangular mesh plot
triplot2-D triangular plot
trisurfTriangular surface plot
triangulationTriangulation in 2-D or 3-D
delaunayTriangulationDelaunay triangulation in 2-D and 3-D
dsearchnN-D nearest point search
tsearchnN-D closest simplex search
delaunayDelaunay triangulation
delaunaynN-D Delaunay triangulation

Bounding Regions

boundaryBoundary of a set of points in 2-D or 3-D
alphaShapePolygons and polyhedra from points in 2-D and 3-D
convhullConvex hull
convhullnN-D convex hull

Voronoi Diagram

patchCreate one or more filled polygons
voronoiVoronoi diagram
voronoinN-D Voronoi diagram

Elementary Polygons

polyshape2-D polygons
nsidedpolyRegular polygon
polyareaArea of polygon
inpolygonPoints located inside or on edge of polygonal region
rectintRectangle intersection area

Graphics

2-D and 3-D Plots

Line Plots

plot2-D line plot
plot33-D line plot
loglogLog-log scale plot
semilogxSemilogarithmic plot
semilogySemilogarithmic plot
errorbarLine plot with error bars
fplotPlot expression or function
fplot33-D parametric curve plotter
fimplicitPlot implicit function
LineSpec (Line Specification)Line specification
ColorSpec (Color Specification)Color specification

Pie Charts, Bar Plots, and Histograms

barBar graph
bar3Plot 3-D bar graph
barhPlot bar graph horizontally
bar3hPlot horizontal 3-D bar graph
histogramHistogram plot
histogram2Bivariate histogram plot
morebinsIncrease number of histogram bins
fewerbinsDecrease number of histogram bins
histcountsHistogram bin counts
histcounts2Bivariate histogram bin counts
binscatterBinned scatter plot
roseAngle histogram plot
paretoPareto chart
areaFilled area 2-D plot
piePie chart
pie33-D pie chart

Discrete Data Plots

stemPlot discrete sequence data
stairsStairstep graph
stem3Plot 3-D discrete sequence data
scatterScatter plot
scatter33-D scatter plot
spyVisualize sparsity pattern
plotmatrixScatter plot matrix
heatmapCreate heatmap chart
sortxSort elements in heatmap row
sortySort elements in heatmap column
wordcloudCreate word cloud chart from text data
geobubbleVisualize data values at specific geographic locations
geolimitsSet or query geographic limits

Polar Plots

polarplotPlot line in polar coordinates
polarscatterScatter chart in polar coordinates
polarhistogramHistogram chart in polar coordinates
compassPlot arrows emanating from origin
ezpolarEasy-to-use polar coordinate plotter
rlimSet or query r-axis limits for polar axes
thetalimSet or query theta-axis limits for polar axes
rticksSet or query r-axis tick values
thetaticksSet or query theta-axis tick values
rticklabelsSet or query r-axis tick labels
thetaticklabelsSet or query theta-axis tick labels
rtickformatSpecify r-axis tick label format
thetatickformatSpecify theta-axis tick label format
rtickangleRotate r-axis tick labels
polaraxesCreate polar axes

Contour Plots

contourContour plot of matrix
contourfFilled 2-D contour plot
contourcLow-level contour plot computation
contour33-D contour plot
contoursliceDraw contours in volume slice planes
clabelLabel contour plot elevation
fcontourPlot contours

Vector Fields

featherPlot velocity vectors
quiverQuiver or velocity plot
compassPlot arrows emanating from origin
quiver33-D quiver or velocity plot
streamslicePlot streamlines in slice planes
streamlinePlot streamlines from 2-D or 3-D vector data

Surfaces, Volumes, and Polygons

Surface and Mesh Plots
surfSurface plot
surfcContour plot under a 3-D shaded surface plot
surfaceCreate surface object
surflSurface plot with colormap-based lighting
surfnormCompute and display 3-D surface normals
meshMesh plot
meshcPlot a contour graph under mesh graph
meshzPlot a curtain around mesh plot
hiddenRemove hidden lines from mesh plot
fsurfPlot 3-D surface
fmeshPlot 3-D mesh
fimplicit3Plot 3-D implicit function
waterfallWaterfall plot
ribbonRibbon plot
contour33-D contour plot
peaksExample function of two variables
cylinderGenerate cylinder
ellipsoidGenerate ellipsoid
sphereGenerate sphere
pcolorPseudocolor (checkerboard) plot
surf2patchConvert surface data to patch data
Volume Visualization
contoursliceDraw contours in volume slice planes
flowSimple function of three variables
isocapsCompute isosurface end-cap geometry
isocolorsCalculate isosurface and patch colors
isonormalsCompute normals of isosurface vertices
isosurfaceExtract isosurface data from volume data
reducepatchReduce number of patch faces
reducevolumeReduce number of elements in volume data set
shrinkfacesReduce size of patch faces
sliceVolumetric slice plot
smooth3Smooth 3-D data
subvolumeExtract subset of volume data set
volumeboundsCoordinate and color limits for volume data
coneplotPlot velocity vectors as cones in 3-D vector field
curlCompute curl and angular velocity of vector field
divergenceCompute divergence of vector field
interpstreamspeedInterpolate stream-line vertices from flow speed
stream2Compute 2-D streamline data
stream3Compute 3-D streamline data
streamlinePlot streamlines from 2-D or 3-D vector data
streamparticlesPlot stream particles
streamribbon3-D stream ribbon plot from vector volume data
streamslicePlot streamlines in slice planes
streamtubeCreate 3-D stream tube plot
Polygons
fillFilled 2-D polygons
fill3Filled 3-D polygons
patchCreate one or more filled polygons
surf2patchConvert surface data to patch data

Animation

moviePlay recorded movie frames
getframeCapture axes or figure as movie frame
frame2imReturn image data associated with movie frame
im2frameConvert image to movie frame
animatedlineCreate animated line
addpointsAdd points to animated line
getpointsReturn points that define animated line
clearpointsClear points from animated line
comet2-D comet plot
comet33-D comet plot
drawnowUpdate figures and process callbacks
refreshdataRefresh data in graph when data source is specified

Formatting and Annotation

Titles and Labels

titleAdd title
xlabelLabel x-axis
ylabelLabel y-axis
zlabelLabel z-axis
clabelLabel contour plot elevation
legendAdd legend to axes
colorbarColorbar showing color scale
textAdd text descriptions to data points
texlabelFormat text with TeX characters
gtextAdd text to figure using mouse
lineCreate primitive line
rectangleCreate rectangle with sharp or curved corners
annotationCreate annotations

Axes Appearance

xlimSet or query x-axis limits
ylimSet or query y-axis limits
zlimSet or query z-axis limits
axisSet axis limits and aspect ratios
boxDisplay axes outline
daspectControl data unit length along each axis
pbaspectControl relative lengths of each axis
gridDisplay or hide axes grid lines
xticksSet or query x-axis tick values
yticksSet or query y-axis tick values
zticksSet or query z-axis tick values
xticklabelsSet or query x-axis tick labels
yticklabelsSet or query y-axis tick labels
zticklabelsSet or query z-axis tick labels
xtickformatSpecify x-axis tick label format
ytickformatSpecify y-axis tick label format
ztickformatSpecify z-axis tick label format
xtickangleRotate x-axis tick labels
ytickangleRotate y-axis tick labels
ztickangleRotate z-axis tick labels
datetickDate formatted tick labels
ruler2numConvert data from specific ruler to numeric data
num2rulerConvert numeric data for use with specific ruler
holdRetain current plot when adding new plots
subplotCreate axes in tiled positions
yyaxisCreate chart with two y-axes
claClear axes
axesCreate Cartesian axes
figureCreate figure window

Colormaps

colormapView and set current colormap
colorbarColorbar showing color scale
rgbplotPlot colormap
Colormap EditorOpen colormap editor
brightenBrighten or darken colormap
contrastCreate grayscale colormap to enhance image contrast
caxisSet colormap limits
spinmapRotate colormap colors
hsv2rgbConvert HSV colors to RGB
rgb2hsvConvert RGB colors to HSV
parulaParula colormap array
jetJet colormap array
hsvHSV colormap array
hotHot colormap array
coolCool colormap array
springSpring colormap array
summerSummer colormap array
autumnAutumn colormap array
winterWinter colormap array
grayGray colormap array
boneBone colormap array
copperCopper colormap array
pinkPink colormap array
linesLines colormap array
colorcubeColorcube colormap array
prismPrism colormap array
flagFlag colormap array

3-D Scene Control

Camera Views
viewViewpoint specification
makehgtformCreate 4-by-4 transform matrix
viewmtxView transformation matrices
cameratoolbarControl camera toolbar programmatically
campanRotate camera target around camera position
camzoomZoom in and out on scene
camdollyMove camera position and target
camlookatPosition camera to view object or group of objects
camorbitRotate camera position around camera target
camposSet or query camera position
camprojSet or query projection type
camrollRotate camera about view axis
camtargetSet or query location of camera target
camupSet or query camera up vector
camvaSet or query camera view angle
Lighting, Transparency, and Shading
camlightCreate or move light object in camera coordinates
lightCreate light
lightangleCreate or position light object in spherical coordinates
lightingSpecify lighting algorithm
shadingSet color shading properties
diffuseCalculate diffuse reflectance
materialControl reflectance properties of surfaces and patches
specularCalculate specular reflectance
alimSet or query axes alpha limits
alphaAdd transparency to objects in axes
alphamapSpecify figure alphamap (transparency)

Images

imshowDisplay image
imageDisplay image from array
imagescDisplay image with scaled colors
imreadRead image from graphics file
imresizeResize image
imwriteWrite image to graphics file
imfinfoInformation about graphics file
imformatsManage image file format registry
frame2imReturn image data associated with movie frame
im2frameConvert image to movie frame
im2javaConvert image to Java image
im2doubleConvert image to double precision
ind2rgbConvert indexed image to RGB image
rgb2grayConvert RGB image or colormap to grayscale
rgb2indConvert RGB image to indexed image
imapproxApproximate indexed image by reducing number of colors
ditherConvert image, increasing apparent color resolution by dithering
cmpermuteRearrange colors in colormap
cmuniqueEliminate duplicate colors in colormap; convert grayscale or truecolor image to indexed image

Printing and Saving

printPrint figure or save to specific file format
saveasSave figure to specific file format
getframeCapture axes or figure as movie frame
savefigSave figure and contents to FIG-file
openfigOpen figure saved in FIG-file
orientPaper orientation for printing or saving
hgexportExport figure
printoptConfigure printer defaults

Graphics Objects

Graphics Object Properties

getQuery graphics object properties
setSet graphics object properties
resetReset graphics object properties to their defaults
inspectOpen Property Inspector

Graphics Object Identification

gcaCurrent axes or chart
gcfCurrent figure handle
gcbfHandle of figure containing object whose callback is executing
gcboHandle of object whose callback is executing
gcoHandle of current object
grootGraphics root object
ancestorAncestor of graphics object
allchildFind all children of specified objects
findallFind all graphics objects
findobjLocate graphics objects with specific properties
findfigsFind visible offscreen figures
gobjectsInitialize array for graphics objects
isgraphicsTrue for valid graphics object handles
ishandleTest for valid graphics or Java object handle
copyobjCopy graphics objects and their descendants
deleteDelete files or objects

Graphics Object Programming

gobjectsInitialize array for graphics objects
isgraphicsTrue for valid graphics object handles
isemptyDetermine whether array is empty
isequalDetermine array equality
isaDetermine if input is object of specified class
clfClear current figure window
claClear axes
closeRemove specified figure

Interactive Control and Callbacks

uicontextmenuCreate context menu
uimenuCreate menu or menu items
dragrectDrag rectangles with mouse
rbboxCreate rubberband box for area selection
refreshRedraw current figure
shgShow most recent graph window

Object Containers

hggroupCreate group object
hgtransformCreate transform object
makehgtformCreate 4-by-4 transform matrix
eyeIdentity matrix

Specifying Target for Graphics Output

holdRetain current plot when adding new plots
isholdCurrent hold state
newplotDetermine where to draw graphics objects
clfClear current figure window
claClear axes

Graphics Performance

drawnowUpdate figures and process callbacks
openglControl OpenGL rendering

Data Import and Analysis

Data Import and Export

Standard File Formats

Text Files
readtableCreate table from file
detectImportOptionsCreate import options based on file content
writetableWrite table to file
textscanRead formatted data from text file or string
dlmreadRead ASCII-delimited file of numeric data into matrix
dlmwriteWrite matrix to ASCII-delimited file
csvreadRead comma-separated value (CSV) file
csvwriteWrite comma-separated value file
typeDisplay contents of file
DelimitedTextImportOptionsImport options object for delimited text
FixedWidthImportOptionsImport options object for fixed-width text files
Spreadsheets
Import ToolImport data from file
readtableCreate table from file
writetableWrite table to file
xlsfinfoDetermine if file contains Microsoft Excel spreadsheet
xlsreadRead Microsoft Excel spreadsheet file
xlswriteWrite Microsoft Excel spreadsheet file
importdataLoad data from file
detectImportOptionsCreate import options based on file content
getvaroptsGet variable import options
setvaroptsSet variable import options
setvartypeSet variable data types
SpreadsheetDatastoreDatastore for spreadsheet files
SpreadsheetImportOptionsImport options object for Spreadsheets
Images
im2javaConvert image to Java image
imfinfoInformation about graphics file
imreadRead image from graphics file
imwriteWrite image to graphics file
TiffMATLAB Gateway to LibTIFF library routines
Scientific Data
NetCDF Files
nccreateCreate variable in NetCDF file
ncdispDisplay contents of NetCDF data source in Command Window
ncinfo Return information about NetCDF data source
ncreadRead data from variable in NetCDF data source
ncreadatt Read attribute value from NetCDF data source
ncwrite Write data to NetCDF file
ncwriteattWrite attribute to NetCDF file
ncwriteschemaAdd NetCDF schema definitions to NetCDF file
HDF5 Files
High-Level Functions
h5createCreate HDF5 data set
h5dispDisplay contents of HDF5 file
h5infoReturn information about HDF5 file
h5readRead data from HDF5 data set
h5readattRead attribute from HDF5 file
h5writeWrite to HDF5 data set
h5writeattWrite HDF5 attribute
Low-Level Functions
Library (H5)
H5.closeClose HDF5 library
H5.garbage_collectFree unused memory in HDF5 library
H5.get_libversionVersion of HDF5 library
H5.openOpen HDF5 library
H5.set_free_list_limitsSet size limits on free lists
Attribute (H5A)
H5A.closeClose specified attribute
H5A.createCreate attribute
H5A.deleteDelete attribute
H5A.get_infoInformation about attribute
H5A.get_nameAttribute name
H5A.get_spaceCopy of attribute data space
H5A.get_typeCopy of attribute data type
H5A.iterateExecute function for attributes attached to object
H5A.openOpen attribute
H5A.open_by_idxOpen attribute specified by index
H5A.open_by_nameOpen attribute specified by name
H5A.readRead attribute
H5A.writeWrite attribute
Dataset (H5D)
H5D.closeClose dataset
H5D.createCreate new dataset
H5D.get_access_plistCopy of dataset access property list
H5D.get_create_plistCopy of dataset creation property list
H5D.get_offsetLocation of dataset in file
H5D.get_spaceCopy of dataset data space
H5D.get_space_statusDetermine if space is allocated
H5D.get_storage_sizeDetermine required storage size
H5D.get_typeCopy of datatype
H5D.openOpen specified dataset
H5D.readRead data from HDF5 dataset
H5D.set_extentChange size of dataset dimensions
H5D.vlen_get_buf_sizeDetermine variable length storage requirements
H5D.writeWrite data to HDF5 dataset
Dimension Scale (H5DS)
H5DS.attach_scaleAttach dimension scale to specific dataset dimension
H5DS.detach_scaleDetach dimension scale from specific dataset dimension
H5DS.get_labelRetrieve label from specific dataset dimension
H5DS.get_num_scalesNumber of scales attached to dataset dimension
H5DS.get_scale_nameName of dimension scale
H5DS.is_scaleDetermine if dataset is a dimension scale
H5DS.iterate_scalesIterate on scales attached to dataset dimension
H5DS.set_labelSet label for dataset dimension
H5DS.set_scaleConvert dataset to dimension scale
Error (H5E)
H5E.clearClear error stack
H5E.get_majorDescription of major error number
H5E.get_minorDescription of minor error number
H5E.walkWalk error stack
File (H5F)
H5F.closeClose HDF5 file
H5F.createCreate HDF5 file
H5F.flushFlush buffers to disk
H5F.get_access_plistFile access property list
H5F.get_create_plistFile creation property list
H5F.get_filesizeSize of HDF5 file
H5F.get_freespaceAmount of free space in file
H5F.get_infoGlobal information about file
H5F.get_mdc_configMetadata cache configuration
H5F.get_mdc_hit_rateMetadata cache hit-rate
H5F.get_mdc_sizeMetadata cache size data
H5F.get_nameName of HDF5 file
H5F.get_obj_countNumber of open objects in HDF5 file
H5F.get_obj_idsList of open HDF5 file objects
H5F.is_hdf5Determine if file is HDF5
H5F.mountMount HDF5 file onto specified location
H5F.openOpen HDF5 file
H5F.reopenReopen HDF5 file
H5F.set_mdc_configConfigure HDF5 file metadata cache
H5F.unmountUnmount file or group from mount point
Group (H5G)
H5G.closeClose group
H5G.createCreate group
H5G.get_infoInformation about group
H5G.openOpen specified group
Identifier (H5I)
H5I.dec_refDecrement reference count
H5I.get_file_idFile identifier for specified object
H5I.get_nameName of object
H5I.get_refReference count of object
H5I.get_typeType of object
H5I.inc_refIncrement reference count of specified object
H5I.is_validDetermine if specified identifier is valid
Link (H5L)
H5L.copyCopy link from source location to destination location
H5L.create_externalCreate soft link to external object
H5L.create_hardCreate hard link
H5L.create_softCreate soft link
H5L.deleteRemove link
H5L.existsDetermine if link exists
H5L.get_infoInformation about link
H5L.get_name_by_idxInformation about link specified by index
H5L.get_valValue of symbolic link
H5L.iterateIterate over links
H5L.iterate_by_nameIterate through links in group specified by name
H5L.moveRename link
H5L.visitRecursively iterate through links in group specified by group identifier
H5L.visit_by_nameRecursively iterate through links in group specified by location and group name
MATLAB (H5ML)
H5ML.compare_valuesNumerically compare two HDF5 values
H5ML.get_constant_namesConstants known by HDF5 library
H5ML.get_constant_valueValue corresponding to a string
H5ML.get_function_namesFunctions provided by HDF5 library
H5ML.get_mem_datatypeData type for dataset ID
Object (H5O)
H5O.closeClose object
H5O.copyCopy object from source location to destination location
H5O.get_commentGet comment for object specified by object identifier
H5O.get_comment_by_nameGet comment for object specified by location and object name
H5O.get_infoObject metadata
H5O.linkCreate hard link to specified object
H5O.openOpen specified object
H5O.open_by_idxOpen object specified by index
H5O.set_commentSet comment for object specified by object identifier
H5O.set_comment_by_nameSet comment for object specified by location and object name
H5O.visitVisit objects specified by object identifier
H5O.visit_by_nameVisit objects specified by location and object name
Property (H5P)
General Property List Operations
H5P.closeClose property list
H5P.copyCopy of property list
H5P.createCreate new property list
H5P.get_classProperty list class
Generic Property List Operations
H5P.close_classClose property list class
H5P.equalDetermine equality of property lists
H5P.existDetermine if specified property exists in property list
H5P.getValue of specified property in property list
H5P.get_class_nameName of property list class
H5P.get_class_parentIdentifier for parent class
H5P.get_npropsQuery number of properties in property list or class
H5P.get_sizeQuery size of property value in bytes
H5P.isa_classDetermine if property list is member of class
H5P.iterateIterate over properties in property list
H5P.setSet property list value
Dataset Access, Memory, and Transfer Properties
H5P.get_btree_ratiosB-tree split ratios
H5P.get_chunk_cacheRaw data chunk cache parameters
H5P.get_edc_checkDetermine if error detection is enabled
H5P.get_hyper_vector_sizeNumber of I/O vectors
H5P.set_btree_ratiosSet B-tree split ratios for dataset transfer
H5P.set_chunk_cacheSet raw data chunk cache parameters
H5P.set_edc_checkEnable error detection for dataset transfer
H5P.set_hyper_vector_sizeSet number of I/O vectors for hyperslab I/O
Dataset Creation Properties
H5P.all_filters_availDetermine availability of all filters
H5P.fill_value_definedDetermine if fill value is defined
H5P.get_alloc_timeReturn timing of storage space allocation
H5P.get_chunkReturn size of chunks
H5P.get_externalReturn information about external file
H5P.get_external_countReturn count of external files
H5P.get_fill_timeReturn time when fill values are written to dataset
H5P.get_fill_valueReturn dataset fill value
H5P.get_filterReturn information about filter in pipeline
H5P.get_filter_by_idReturn information about specified filter
H5P.get_layoutDetermine layout of raw data for dataset
H5P.get_nfiltersReturn number of filters in pipeline
H5P.modify_filterModify filter in pipeline
H5P.remove_filterRemove filter from property list
H5P.set_alloc_timeSet timing for storage space allocation
H5P.set_chunkSet chunk size
H5P.set_deflateSet compression method and compression level
H5P.set_externalAdd additional file to external file list
H5P.set_fill_timeSet time when fill values are written to dataset
H5P.set_fill_valueSet fill value for dataset creation property list
H5P.set_filterAdd filter to filter pipeline
H5P.set_fletcher32Set Fletcher32 checksum filter in dataset creation
H5P.set_layoutSet type of storage for dataset
H5P.set_nbitSet N-Bit filter
H5P.set_scaleoffsetSet Scale-Offset filter
H5P.set_shuffleSet shuffle filter
File Access Properties
H5P.get_alignmentRetrieve alignment properties
H5P.get_driverLow-level file driver
H5P.get_family_offsetOffset for family file driver
H5P.get_fapl_coreInformation about core file driver properties
H5P.get_fapl_familyFile access property list information
H5P.get_fapl_multiInformation about multifile access property list
H5P.get_fclose_degreeFile close degree
H5P.get_libver_boundsLibrary version bounds settings
H5P.get_gc_referencesGarbage collection references setting
H5P.get_mdc_configMetadata cache configuration
H5P.get_meta_block_sizeMetadata block size setting
H5P.get_multi_typeType of data property for MULTI driver
H5P.get_sieve_buf_sizeMaximum data sieve buffer size
H5P.get_small_data_block_sizeSmall data block size setting
H5P.set_alignmentSet alignment properties for file access property list
H5P.set_family_offsetSet offset property for family of files
H5P.set_fapl_coreModify file access to use H5FD_CORE driver
H5P.set_fapl_familySet file access to use family driver
H5P.set_fapl_logSet use of logging driver
H5P.set_fapl_multiSet use of multifile driver
H5P.set_fapl_sec2Set file access for sec2 driver
H5P.set_fapl_splitSet file access for emulation of split file driver
H5P.set_fapl_stdioSet file access for standard I/O driver
H5P.set_fclose_degreeSet file access for file close degree
H5P.set_gc_referencesSet garbage collection references flag
H5P.set_libver_boundsSet library version bounds for objects
H5P.set_mdc_configSet initial metadata cache configuration
H5P.set_meta_block_sizeSet minimum metadata block size
H5P.set_multi_typeSpecify type of data accessed with MULTI driver
H5P.set_sieve_buf_sizeSet maximum size of data sieve buffer
H5P.set_small_data_block_sizeSet size of block reserved for small data
File Creation Properties
H5P.get_istore_kReturn 1/2 rank of indexed storage B-tree
H5P.get_sizesReturn size of offsets and lengths
H5P.get_sym_kReturn size of B-tree 1/2 rank and leaf node 1/2 size
H5P.get_userblockReturn size of user block
H5P.get_versionReturn version information for file creation property list
H5P.set_istore_kSet size of parameter for indexing chunked datasets
H5P.set_sizesSet byte size of offsets and lengths
H5P.set_sym_kSet size of parameters used to control symbol table nodes
H5P.set_userblockSet user block size
Object Copy and Object Creation Properties
H5P.get_attr_creation_orderReturn tracking order and indexing settings
H5P.get_attr_phase_changeRetrieve attribute phase change thresholds
H5P.get_copy_objectReturn properties to be used when object is copied
H5P.set_attr_creation_orderSet tracking of attribute creation order
H5P.set_attr_phase_changeSet attribute storage phase change thresholds
H5P.set_copy_objectSet properties to be used when objects are copied
Group Creation Properties
H5P.get_create_intermediate_groupDetermine creation of intermediate groups
H5P.get_link_creation_orderQuery if link creation order is tracked
H5P.get_link_phase_changeQuery settings for conversion between groups
H5P.set_create_intermediate_groupSet creation of intermediate groups
H5P.set_link_creation_orderSet creation order tracking and indexing
H5P.set_link_phase_changeSet parameters for group conversion
HDF5 String Properties
H5P.get_char_encodingReturn character encoding
H5P.set_char_encodingSet character encoding used to encode strings
Reference (H5R)
H5R.createCreate reference
H5R.dereferenceOpen object specified by reference
H5R.get_nameName of referenced object
H5R.get_obj_typeType of referenced object
H5R.get_regionCopy of data space of specified region
Dataspace (H5S)
H5S.copyCreate copy of data space
H5S.createCreate new data space
H5S.closeClose data space
H5S.create_simpleCreate new simple data space
H5S.extent_copyCopy extent from source to destination data space
H5S.is_simpleDetermine if data space is simple
H5S.offset_simpleSet offset of simple data space
H5S.select_allSelect entire extent of data space
H5S.select_elementsSpecify coordinates to include in selection
H5S.select_hyperslabSelect hyperslab region
H5S.select_noneReset selection region to include no elements
H5S.select_validDetermine validity of selection
H5S.set_extent_noneRemove extent from data space
H5S.set_extent_simpleSet size of data space
H5S.get_select_boundsBounding box of data space selection
H5S.get_select_elem_npointsNumber of element points in selection
H5S.get_select_elem_pointlistElement points in data space selection
H5S.get_select_hyper_blocklistList of hyperslab blocks
H5S.get_select_hyper_nblocksNumber of hyperslab blocks
H5S.get_select_npointsNumber of elements in data space selection
H5S.get_select_typeType of data space selection
H5S.get_simple_extent_dimsData space size and maximum size
H5S.get_simple_extent_ndimsData space rank
H5S.get_simple_extent_npointsNumber of elements in data space
H5S.get_simple_extent_typeData space class
Datatype (H5T)
General Data Type Operation
H5T.closeClose data type
H5T.commitCommit transient data type
H5T.committedDetermine if data type is committed
H5T.copyCopy data type
H5T.createCreate new data type
H5T.detect_classDetermine of data type contains specific class
H5T.equalDetermine equality of data types
H5T.get_classData type class identifier
H5T.get_create_plistCopy of data type creation property list
H5T.get_native_typeNative data type of dataset data type
H5T.get_sizeSize of data type in bytes
H5T.get_superBase data type
H5T.lockLock data type
H5T.openOpen named data type
Array Data Type
H5T.array_createCreate array data type object
H5T.get_array_dimsArray dimension extents
H5T.get_array_ndimsRank of array data type
Atomic Data Type Properties
H5T.get_csetCharacter set of string data type
H5T.get_ebiasExponent bias of floating-point type
H5T.get_fieldsFloating-point data type bit field information
H5T.get_inpadInternal padding type for floating-point data types
H5T.get_normMantissa normalization type
H5T.get_offsetBit offset of first significant bit
H5T.get_orderByte order of atomic data type
H5T.get_padPadding type of least and most-significant bits
H5T.get_precisionPrecision of atomic data type
H5T.get_signSign type for integer data type
H5T.get_strpadStorage mechanism for string data type
H5T.set_csetSet character dataset for string data type
H5T.set_ebiasSet exponent bias of floating-point data type
H5T.set_fieldsSet sizes and locations of floating-point bit fields
H5T.set_inpadSpecify how unused internal bits are to be filled
H5T.set_normSet mantissa normalization of floating-point data type
H5T.set_offsetSet bit offset of first significant bit
H5T.set_orderSet byte ordering of atomic data type
H5T.set_padSet padding type for least and most significant bits
H5T.set_precisionSet precision of atomic data type
H5T.set_signSet sign property for integer data type
H5T.set_sizeSet size of data type in bytes
H5T.set_strpadSet storage mechanism for string data type
Compound Data Type
H5T.get_member_classData type class for compound data type member
H5T.get_member_indexIndex of compound or enumeration type member
H5T.get_member_nameName of compound or enumeration type member
H5T.get_member_offsetOffset of field of compound data type
H5T.get_member_typeData type of specified member
H5T.get_nmembersNumber of elements in enumeration type
H5T.insertAdd member to compound data type
H5T.packRecursively remove padding from compound data type
Enumeration Data Type
H5T.enum_createCreate new enumeration data type
H5T.enum_insertInsert enumeration data type member
H5T.enum_nameofName of enumeration data type member
H5T.enum_valueofValue of enumeration data type member
H5T.get_member_valueValue of enumeration data type member
Opaque Data Type Properties
H5T.get_tagTag associated with opaque data type
H5T.set_tagTag opaque data type with description
Variable-length Data Type
H5T.is_variable_strDetermine if data type is variable-length string
H5T.vlen_createCreate new variable-length data type
Filters and Compression (H5Z)
H5Z.filter_availDetermine if filter is available
H5Z.get_filter_infoInformation about filter
HDF4 Files
High-Level Functions
hdfinfoInformation about HDF4 or HDF-EOS file
hdfreadRead data from HDF4 or HDF-EOS file
hdftoolBrowse and import data from HDF4 or HDF-EOS files
imreadRead image from graphics file
imwriteWrite image to graphics file
Low-Level Functions
hdfanGateway to HDF multifile annotation (AN) interface
hdfhxGateway to HDF external data (HX) interface
hdfhGateway to HDF H interface
hdfhdGateway to HDF HD interface
hdfheGateway to HDF HE interface
hdfmlUtilities for working with MATLAB HDF gateway functions
hdfptInterface to HDF-EOS Point object
hdfvGateway to HDF Vgroup (V) interface
hdfvfGateway to VF functions in HDF Vdata interface
hdfvhGateway to VH functions in HDF Vdata interface
hdfvsGateway to VS functions in HDF Vdata interface
hdfdf24Gateway to HDF 24-bit raster image (DF24) interface
hdfdfr8Gateway to HDF 8-bit raster image (DFR8) interface
FITS Files
High-Level Functions
fitsdispDisplay FITS metadata
fitsinfoInformation about FITS file
fitsreadRead data from FITS file
fitswriteWrite image to FITS file
Low-Level Functions
File Access
createFileCreate FITS file
openFileOpen FITS file
closeFileClose FITS file
deleteFileDelete FITS file
fileNameName of FITS file
fileModeI/O mode of FITS file
Image Manipulation
createImgCreate FITS image
getImgSizeSize of image
getImgTypeData type of image
insertImgInsert FITS image after current image
readImgRead image data
setBscaleReset image scaling
writeImgWrite to FITS image
Keywords
readCardHeader record of keyword
readKeyKeyword
readKeyCmplxKeyword as complex scalar value
readKeyDblKeyword as double precision value
readKeyLongLongKeyword as int64
readKeyLongStrLong string value
readKeyUnitPhysical units string from keyword
readRecordHeader record specified by number
writeCommentWrite or append COMMENT keyword to CHU
writeDateWrite DATE keyword to CHU
writeKeyUpdate or add new keyword into current HDU
writeKeyUnitWrite physical units string
writeHistoryWrite or append HISTORY keyword to CHU
deleteKeyDelete key by name
deleteRecordDelete key by record number
getHdrSpaceNumber of keywords in header
Header Data Unit (HDU) Access
copyHDUCopy current HDU from one file to another
getHDUnumNumber of current HDU in FITS file
getHDUtypeType of current HDU
getNumHDUsTotal number of HDUs in FITS file
movAbsHDUMove to absolute HDU number
movNamHDUMove to first HDU having specific type and keyword values
movRelHDUMove relative number of HDUs from current HDU
writeChecksumCompute and write checksum for current HDU
deleteHDUDelete current HDU in FITS file
Image Compression
imgCompressCompress HDU from one file into another
isCompressedImgDetermine if current image is compressed
setCompressionTypeSet image compression type
setHCompScaleSet scale parameter for HCOMPRESS algorithm
setHCompSmoothSet smoothing for images compressed with HCOMPRESS
setTileDimSet tile dimensions
ASCII and Binary Tables
createTblCreate new ASCII or binary table extension
insertColInsert column into table
insertRowsInsert rows into table
insertATblInsert ASCII table after current HDU
insertBTblInsert binary table after current HDU
deleteColDelete column from table
deleteRowsDelete rows from table
getAColParmsASCII table information
getBColParmsBinary table information
getColNameTable column name
getColTypeScaled column data type, repeat value, width
getEqColTypeColumn data type, repeat value, width
getNumColsNumber of columns in table
getNumRowsNumber of rows in table
readATblHdrRead header information from current ASCII table
readBTblHdrRead header information from current binary table
readColRead rows of ASCII or binary table column
setTscaleReset image scaling
writeColWrite elements into ASCII or binary table column
Utilities
getConstantValueNumeric value of named constant
getVersionRevision number of the CFITSIO library
getOpenFilesList of open FITS files
Band-Interleaved Files
multibandreadRead band-interleaved data from binary file
multibandwriteWrite band-interleaved data to file
Common Data Format
cdfinfoInformation about Common Data Format (CDF) file
cdfreadRead data from Common Data Format (CDF) file
cdfepochConvert date text or serial date number to CDF formatted dates
todatenumConvert CDF epoch object to MATLAB serial date number
Audio and Video
Reading and Writing Files
audioinfoInformation about audio file
audioreadRead audio file
audiowriteWrite audio file
VideoReaderCreate object to read video files
VideoWriterCreate object to write video files
mmfileinfoInformation about multimedia file
lin2muConvert linear audio signal to mu-law
mu2linConvert mu-law audio signal to linear
VideoReaderRead video files
VideoWriterWrite video files
Audio Recording and Playback
audiodevinfoInformation about audio device
audioplayerCreate object for playing audio
audiorecorderCreate object for recording audio
soundConvert matrix of signal data to sound
soundscScale data and play as sound
beepProduce operating system beep sound
XML Documents
xmlreadRead XML document and return Document Object Model node
xmlwriteWrite XML Document Object Model node
xsltTransform XML document using XSLT engine

Workspace Variables and MAT-Files

loadLoad variables from file into workspace
saveSave workspace variables to file
matfileAccess and change variables directly in MAT-files, without loading into memory
dispDisplay value of variable
whoList variables in workspace
whosList variables in workspace, with sizes and types
clearRemove items from workspace, freeing up system memory
clearvarsClear variables from memory
openvarOpen workspace variable in Variables editor or other graphical editing tool

Low-Level File I/O

fcloseClose one or all open files
feofTest for end of file
ferrorFile I/O error information
fgetlRead line from file, removing newline characters
fgetsRead line from file, keeping newline characters
filereadRead contents of file as text
fopenOpen file, or obtain information about open files
fprintfWrite data to text file
freadRead data from binary file
frewindMove file position indicator to beginning of open file
fscanfRead data from text file
fseekMove to specified position in file
ftellCurrent position
fwriteWrite data to binary file

TCP/IP Communication

tcpclientCreate TCP/IP client object to communicate over TCP/IP
readRead data from remote host over TCP/IP
writeWrite data to remote host over TCP/IP

Web Access

webOpen web page or file in browser
webreadRead content from RESTful web service
webwriteWrite data to RESTful web service
websaveSave content from RESTful web service to file
weboptionsSpecify parameters for RESTful web service
sendmailSend email message to address list
ftpConnect to FTP server

JSON Format

jsondecodeDecode JSON-formatted text
jsonencodeCreate JSON-formatted text from structured MATLAB data

Serial Port Devices

delete (serial)Remove serial port object from memory
fclose (serial)Disconnect serial port object from device
fgetl (serial)Read line of ASCII text from device and discard terminator
fgets (serial)Read line of text from device and include terminator
fopen (serial)Connect serial port object to device
fprintf (serial)Write text to device
fread (serial)Read binary data from device
fscanf (serial)Read ASCII data from device, and format as text
fwrite (serial)Write binary data to device
get (serial)Serial port object properties
isvalid (serial)Determine whether serial port objects are valid
readasyncRead data asynchronously from device
serialCreate serial port object
serialbreakSend break to device connected to serial port
seriallistList of serial ports connected to your system
set (serial)Configure or display serial port object properties
stopasyncStop asynchronous read and write operations
clear (serial)Remove serial port object from MATLAB workspace
disp (serial)Serial port object summary information
instrcallbackEvent information when event occurs
instrfindRead serial port objects from memory to MATLAB workspace
instrfindallFind visible and hidden serial port objects
load (serial)Load serial port objects and variables into MATLAB workspace
length (serial)Length of serial port object array
recordRecord data and event information to file
save (serial)Save serial port objects and variables to file
size (serial)Size of serial port object array

Large Files and Big Data

Datastore

datastoreCreate datastore for large collections of data
TabularTextDatastoreDatastore for tabular text files
SpreadsheetDatastoreDatastore for spreadsheet files
ImageDatastoreDatastore for image data
FileDatastoreDatastore with custom file reader
KeyValueDatastoreDatastore for key-value pair data for use with mapreduce
TallDatastoreDatastore for checkpointing tall arrays
readRead data in datastore
readallRead all data in datastore
previewSubset of data in datastore
partitionPartition a datastore
numpartitionsNumber of datastore partitions
hasdataDetermine if data is available to read
resetReset datastore to initial state
matlab.io.Datastore Base datastore class
matlab.io.datastore.PartitionableAdd parallelization support to datastore
matlab.io.datastore.HadoopFileBased Add Hadoop file support to datastore
matlab.io.datastore.DsFileSet File-set object for collection of files in datastore
matlab.io.datastore.DsFileReader File-reader object for files in a datastore

Tall Arrays

tallCreate tall array
datastoreCreate datastore for large collections of data
mapreducerDefine execution environment for mapreduce or tall arrays
gatherCollect tall array into memory after executing queued operations
headGet top rows of table, timetable, or tall array
tailGet bottom rows of table, timetable, or tall array
topkrowsTop rows in sorted order
istallDetermine if input is tall array
classUnderlyingClass of underlying data in tall array
isaUnderlyingDetermine if tall array data is of specified class
writeWrite tall array to disk for checkpointing
tallrngControl random number generation for tall arrays

MapReduce

mapreduceProgramming technique for analyzing data sets that do not fit in memory
datastoreCreate datastore for large collections of data
addAdd single key-value pair to KeyValueStore
addmultiAdd multiple key-value pairs to KeyValueStore
hasnextDetermine if ValueIterator has one or more values available
getnextGet next value from ValueIterator
mapreducerDefine execution environment for mapreduce or tall arrays
gcmrGet current mapreducer configuration
KeyValueStoreStore key-value pairs for use with mapreduce
ValueIteratorAn iterator over intermediate values for use with mapreduce

Large MAT-Files

matfileAccess and change variables directly in MAT-files, without loading into memory

Memory Mapping

memmapfileCreate memory map to a file

Preprocessing Data

ismissingFind missing values
rmmissingRemove missing entries
fillmissingFill missing values
missingCreate missing values
standardizeMissingInsert standard missing values
isoutlierFind outliers in data
filloutliersDetect and replace outliers in data
ischangeFind abrupt changes in data
islocalminFind local minima
islocalmaxFind local maxima
smoothdataSmooth noisy data
movmeanMoving mean
movmedianMoving median
rescaleScale range of array elements
detrendRemove linear trends
discretizeGroup data into bins or categories
histcountsHistogram bin counts
histcounts2Bivariate histogram bin counts
findgroupsFind groups and return group numbers
splitapplySplit data into groups and apply function
rowfunApply function to table or timetable rows
varfunApply function to table or timetable variables
accumarrayConstruct array with accumulation

Descriptive Statistics

minSmallest elements in array
minkFind k smallest elements of array
maxLargest elements in array
maxkFind k largest elements of array
boundsSmallest and largest elements
meanAverage or mean value of array
medianMedian value of array
modeMost frequent values in array
stdStandard deviation
varVariance
corrcoefCorrelation coefficients
covCovariance
cummaxCumulative maximum
cumminCumulative minimum
movmadMoving median absolute deviation
movmaxMoving maximum
movmeanMoving mean
movmedianMoving median
movminMoving minimum
movprodMoving product
movstdMoving standard deviation
movsumMoving sum
movvarMoving variance

Visual Exploration

panPan view of graph interactively
zoomTurn zooming on or off or magnify by factor
rotateRotate object about specified origin and direction
rotate3dRotate 3-D view using mouse
brushInteractively mark, delete, modify, and save observations in graphs
datacursormodeEnable, disable, and manage interactive data cursor mode
ginputGraphical input from mouse or cursor
linkdataAutomatically update graphs when variables change
linkaxesSynchronize limits of specified 2-D axes
linkpropKeep same value for corresponding properties of graphics objects
refreshdataRefresh data in graph when data source is specified
figurepaletteShow or hide Figure Palette
plotbrowserShow or hide figure Plot Browser
ploteditInteractively edit and annotate plots
plottoolsShow or hide plot tools
propertyeditorShow or hide Property Editor
propeditOpen Property Editor
showplottoolShow or hide figure plot tool

Programming Scripts and Functions

Control Flow

if, elseif, elseExecute statements if condition is true
forfor loop to repeat specified number of times
parforParallel for loop
switch, case, otherwiseExecute one of several groups of statements
try, catchExecute statements and catch resulting errors
whilewhile loop to repeat when condition is true
breakTerminate execution of for or while loop
continuePass control to next iteration of for or while loop
endTerminate block of code, or indicate last array index
pauseStop MATLAB execution temporarily
returnReturn control to invoking function

Scripts

editEdit or create file
inputRequest user input
publishGenerate view of MATLAB file in specified format
grabcodeExtract MATLAB code from file published to HTML
snapnowForce snapshot of image for inclusion in published document

Functions

Function Basics

functionDeclare function name, inputs, and outputs

Input and Output Arguments

narginNumber of function input arguments
nargoutNumber of function output arguments
vararginVariable-length input argument list
varargoutVariable-length output argument list
narginchkValidate number of input arguments
nargoutchkValidate number of output arguments
validateattributesCheck validity of array
validatestringCheck validity of text
inputParserInput parser for functions
inputnameVariable name of function input
mfilenameFile name of currently running code

Variables

isvarnameDetermine if input is valid variable name
matlab.lang.makeUniqueStringsConstruct unique strings from input strings
matlab.lang.makeValidNameConstruct valid MATLAB identifiers from input strings
namelengthmaxMaximum identifier length
persistentDefine persistent variable
assigninAssign value to variable in specified workspace
globalDeclare variables as global
mlockPrevent clearing function from memory
munlockAllow clearing functions from memory
mislockedDetermine if function is locked in memory

Error Handling

try, catchExecute statements and catch resulting errors
errorThrow error and display message
warningDisplay warning message
lastwarnLast warning message
assertThrow error if condition false
onCleanupCleanup tasks upon function completion

Files and Folders

Search Path

addpathAdd folders to search path
rmpathRemove folders from search path
pathView or change search path
savepathSave current search path
userpathView or change default user work folder
genpathGenerate path name
pathsepSearch path separator for current platform
pathtoolOpen Set Path dialog box to view and change search path
restoredefaultpathRestore search path to factory-installed state
rehashRefresh function and file system path caches

File Operations

dirList folder contents
lsList folder contents
pwdIdentify current folder
fileattribSet or get attributes of file or folder
existCheck existence of variable, script, function, folder, or class
isfileDetermine if input is file
isfolderDetermine if input is folder
typeDisplay contents of file
visdiffCompare two files or folders
whatList MATLAB files in folder
whichLocate functions and files
cdChange current folder
copyfileCopy file or folder
deleteDelete files or objects
recycleSet option to move deleted files to recycle folder
mkdirMake new folder
movefileMove file or folder
rmdirRemove folder
openOpen file in appropriate application
winopenOpen file in appropriate application (Windows)

File Compression

zipCompress files into zip file
unzipExtract contents of zip file
gzipCompress files into GNU zip files
gunzipExtract contents of GNU zip file
tarCompress files into tar file
untarExtract contents of tar file

File Name Construction

filepartsGet parts of file name
fullfileBuild full file name from parts
filemarkerCharacter to separate file name from local or nested function name
filesepFile separator for current platform
tempdirName of temporary folder for the system
tempnameUnique name for temporary file
matlabrootMATLAB root folder
toolboxdirRoot folder for specified toolbox

Debugging

dbclearRemove breakpoints
dbcontResume execution
dbdownReverse dbup workspace shift
dbquitQuit debug mode
dbstackFunction call stack
dbstatusList all breakpoints
dbstepExecute next executable line from current breakpoint
dbstopSet breakpoints for debugging
dbtypeDisplay file with line numbers
dbupShift current workspace to workspace of caller in debug mode
keyboardInput from keyboard
echoDisplay statements during function execution

Code Editor

editEdit or create file

Code Analysis and Execution

codeCompatibilityReportCreate code compatibility report
analyzeCodeCompatibilityCreate code compatibility analysis results
checkcodeCheck MATLAB code files for possible problems
mlintrptRun checkcode for file or folder
assertThrow error if condition false
runtestsRun set of tests
testsuiteCreate suite of tests
pcodeCreate protected function file
evalExecute MATLAB expression in text
evalcEvaluate MATLAB expression with capture
evalinExecute MATLAB expression in specified workspace
fevalEvaluate function
runRun MATLAB script
builtinExecute built-in function from overloaded method
timerCreate object to schedule execution of MATLAB commands

App Building

App Designer

Components in App Designer

uiaxes(App Designer) Create UI axes for plots in App Designer
uibutton(App Designer) Create push button or state button component
uibuttongroupCreate button group to manage radio buttons and toggle buttons
uicheckbox(App Designer) Create check box component
uidropdown(App Designer) Create drop-down component
uieditfield(App Designer) Create text or numeric edit field component
uilabel(App Designer) Create label component
uilistbox(App Designer) Create list box component
uimenuCreate menu or menu items
uiradiobutton(App Designer) Create radio button component
uislider(App Designer) Create slider component
uispinner(App Designer) Create spinner component
uitable Create table user interface component
uitextarea(App Designer) Create text area component
uitogglebutton(App Designer) Create toggle button component
uitree(App Designer) Create tree component
uitreenode(App Designer) Create tree node component
expand(App Designer) Expand tree node
collapse(App Designer) Collapse tree node
move(App Designer) Move tree node
scroll(App Designer) Scroll to location within list box or tree
uifigure(App Designer) Create UI figure window
uipanelCreate panel container object
uitabgroupCreate container for tabbed panels
uitabCreate tabbed panel
uigauge(App Designer) Create circular, linear, ninety-degree, or semicircular gauge component
uiknob(App Designer) Create continuous or discrete knob component
uilamp(App Designer) Create lamp component
uiswitch(App Designer) Create slider switch, rocker switch, or toggle switch component
uialert(App Designer) Display alert dialog box for UI figure window
uiconfirm(App Designer) Create confirmation dialog box
questdlgCreate question dialog box
inputdlgCreate dialog box that gathers user input
listdlgCreate list selection dialog box
uisetcolorOpen color picker
uigetfileOpen file selection dialog box
uiputfileOpen dialog box for saving files
uigetdirOpen folder selection dialog box
uiopenOpen dialog box for selecting files to load into workspace
uisaveOpen dialog box for saving variables to MAT-file

Coding App Behavior in App Designer

appdesignerCreate or edit app file in App Designer

GUIDE or Programmatic Workflow

Components and Layout

figureCreate figure window
axesCreate Cartesian axes
uicontrolCreate user interface control object
uitable Create table user interface component
uipanelCreate panel container object
uibuttongroupCreate button group to manage radio buttons and toggle buttons
uitabCreate tabbed panel
uitabgroupCreate container for tabbed panels
uimenuCreate menu or menu items
uicontextmenuCreate context menu
uitoolbarCreate toolbar on figure
uipushtoolCreate push button on toolbar
uitoggletoolCreate toggle button on toolbar
actxcontrolCreate Microsoft ActiveX control in figure window
alignAlign UI components and graphics objects
moveguiMove UI figure to specified location on screen
getpixelpositionGet component position in pixels
setpixelpositionSet component position in pixels
listfontsList available system fonts
textwrapWrap text for uicontrol
uistackReorder visual stacking order of objects
inspectOpen Property Inspector

Dialog Boxes

errordlgCreate error dialog box
warndlgCreate warning dialog box
msgboxCreate message dialog box
helpdlgCreate help dialog box
waitbarOpen or update wait bar dialog box
questdlgCreate question dialog box
inputdlgCreate dialog box that gathers user input
listdlgCreate list selection dialog box
uisetcolorOpen color picker
uisetfontOpen font selection dialog box
export2wsdlgCreate dialog box for exporting variables to workspace
uigetfileOpen file selection dialog box
uiputfileOpen dialog box for saving files
uigetdirOpen folder selection dialog box
uiopenOpen dialog box for selecting files to load into workspace
uisaveOpen dialog box for saving variables to MAT-file
printdlgOpen figure Print dialog box
printpreviewOpen figure Print Preview dialog box
exportsetupdlgOpen figure Export Setup dialog box
dialogCreate empty modal dialog box
uigetprefConditionally open dialog box according to user preference

Coding App Behavior

guideOpen GUIDE
uiwaitBlock program execution and wait to resume
uiresumeResume execution of blocked program
waitforBlock execution and wait for condition
waitforbuttonpressWait for key press or mouse-button click
closereqDefault figure close request function
getappdataRetrieve application-defined data
setappdataStore application-defined data
isappdataTrue if application-defined data exists
rmappdataRemove application-defined data
guidataStore or retrieve UI data
guihandlesCreate structure containing all child objects of Figure
uisetprefManage preferences used in uigetpref

Packaging Apps

matlab.apputil.createCreate or modify app project file for packaging app into .mlappinstall file using interactive dialog box
matlab.apputil.packagePackage app files into .mlappinstall file
matlab.apputil.installInstall app from a .mlappinstall file
matlab.apputil.runRun app programmatically
matlab.apputil.getInstalledAppInfoList installed app information
matlab.apputil.uninstallUninstall app

Advanced Software Development

Object-Oriented Programming

Class Syntax Guide

classDetermine class of object
isobjectDetermine if input is MATLAB object
enumerationDisplay class enumeration members and names
eventsEvent names
methodsClass method names
propertiesClass property names

Sample Class Implementations

classdefClass definition keywords

Class Definition

Class File Organization
classdefClass definition keywords
importAdd package or class to current import list
Properties
propertiesClass property names
ispropDetermine if property of object
mustBeFiniteValidate that value is finite or issue error
mustBeGreaterThanValidate that value is greater than another value or issue error
mustBeGreaterThanOrEqualValidate that value is greater than or equal to another value or issue error
mustBeIntegerValidate that value is integer or issue error
mustBeLessThanValidate that value is less than another value or issue error
mustBeLessThanOrEqualValidate that value is less than or equal to another value or issue error
mustBeMemberValidate that value is member of specified set
mustBeNegativeValidate that value is negative or issue error
mustBeNonemptyValidate that value is nonempty or issue error
mustBeNonNanValidate that value is nonNaN
mustBeNonnegativeValidate that value is nonnegative or issue error
mustBeNonpositiveValidate that value is nonpositive or issue error
mustBeNonsparseValidate that value is nonsparse or issue error
mustBeNonzeroValidate that value is nonzero or issue error
mustBeNumericValidate that value is numeric or issue error
mustBeNumericOrLogicalValidate that value is numeric or logical or issue error
mustBePositiveValidate that value is positive or issue error
mustBeRealValidate that value is real or issue error
dynamicpropsSuperclass for classes that support dynamic properties
meta.DynamicPropertyDescribe dynamic property of MATLAB object
event.DynamicPropertyEventEvent data for dynamic property events
meta.propertyDescribe property of MATLAB class
matlab.lang.OnOffSwitchStateRepresent on and off states with logical values
Methods
methodsClass method names
ismethodDetermine if method of object
meta.methodDescribe method of MATLAB class
Handle Classes
isequalDetermine array equality
eqDetermine equality
handleSuperclass of all handle classes
matlab.mixin.SetGetProvide handle classes with set and get methods
matlab.mixin.SetGetExactNamesRequire exact name match for set and get methods
dynamicpropsSuperclass for classes that support dynamic properties
matlab.mixin.CopyableSuperclass providing copy functionality for handle objects
Events
eventsEvent names
handle.notifyNotify listeners that event is occurring
handle.addlistenerCreate event listener bound to event source
handle.listenerCreate event listener without binding to event source
event.hasListenerDetermine if listeners exist for event
event.EventDataBase class for event data
event.listenerClass defining listener objects
event.PropertyEventData for property events
event.proplistenerDefine listener object for property events
Class Hierarchies
Subclass Definition
superclassesNames of superclasses
matlab.mixin.HeterogeneousSuperclass for heterogeneous array formation
Enumerations
enumerationDisplay class enumeration members and names
isenumDetermine if variable is enumeration
meta.EnumeratedValueDescribe enumeration member of MATLAB class

Class Customization

Object Indexing
numArgumentsFromSubscriptNumber of arguments for customized indexing methods
subsrefRedefine subscripted reference for objects
subsasgnRedefine subscripted assignment
subsindexConvert object to array index
substructCreate structure argument for subsasgn or subsref
builtinExecute built-in function from overloaded method
Object Arrays
emptyCreate empty array
matlab.mixin.HeterogeneousSuperclass for heterogeneous array formation
Object Display
dispDisplay value of variable
displayUsed internally for command-window display
detailsDisplay array details
matlab.mixin.CustomDisplayInterface for customizing object display
matlab.mixin.util.PropertyGroupCustom property list for object display
Object Save and Load
saveobjModify save process for object
loadobjCustomize load process for objects

Class Editing

editEdit or create file

Class Metadata

metaclassObtain meta.class object
meta.abstractDetailsFind abstract methods and properties
meta.class.fromNameReturn meta.class object associated with named class
meta.package.fromNameReturn meta.package object for specified package
meta.package.getAllPackagesGet all top-level packages
propertiesClass property names
methodsClass method names
eventsEvent names
superclassesNames of superclasses
meta.classDescribe MATLAB class
meta.propertyDescribe property of MATLAB class
meta.methodDescribe method of MATLAB class
meta.eventDescribe event of MATLAB class
meta.packageDescribe MATLAB package
meta.DynamicPropertyDescribe dynamic property of MATLAB object
meta.EnumeratedValueDescribe enumeration member of MATLAB class
meta.MetaDataSuperclass for MATLAB object metadata

System Objects

Use System Objects
stepRun System object algorithm
cloneCreate duplicate System object
getNumInputsNumber of inputs required to call the System object
getNumOutputsNumber of outputs from calling the System object
isLockedDetermine if System object is locked
resetReset internal states of System object
releaseRelease resources and allow changes to System object property values and input characteristics
Create System Objects
matlab.SystemBase class for System objects
matlab.system.StringSetSet of valid character vector values
matlab.system.mixin.FiniteSourceFinite source mixin class

Calling External Functions

Call MEX File Functions

mexextBinary MEX file-name extension
inmemNames of functions, MEX-files, classes in memory

Call C Shared Libraries

loadlibraryLoad C/C++ shared library into MATLAB
unloadlibraryUnload shared library from memory
libisloadedDetermine if shared library is loaded
calllibCall function in shared library
libfunctionsReturn information on functions in shared library
libfunctionsviewDisplay shared library function signatures in window
libstructConvert MATLAB structure to C-style structure for use with shared library
libpointerPointer object for use with shared library
lib.pointerPointer object compatible with C pointer

Call Java Libraries

importAdd package or class to current import list
isjavaDetermine if input is Java object
javaaddpathAdd entries to dynamic Java class path
javaArrayConstruct Java array object
javachkError message based on Java feature support
javaclasspathReturn Java class path or specify dynamic path
javaMethodCall Java method
javaMethodEDTCall Java method from Event Dispatch Thread (EDT)
javaObjectCall Java constructor
javaObjectEDTCall Java constructor on Event Dispatch Thread (EDT)
javarmpathRemove entries from dynamic Java class path
usejavaDetermine if Java feature is available
matlab.exception.JavaExceptionCapture error information for Java exception

Call .NET Libraries

Getting Started with Microsoft .NET
NET.addAssemblyMake .NET assembly visible to MATLAB
NET.isNETSupportedCheck for supported Microsoft .NET Framework
NETSummary of functions in MATLAB .NET interface
enableNETfromNetworkDriveEnable access to .NET commands from network drive
NET.AssemblyMembers of .NET assembly
NET.NetExceptionCapture error information for .NET exception
Data Types
cellCell array
NET.createArrayArray for nonprimitive .NET types
NET.disableAutoReleaseLock .NET object representing a RunTime Callable Wrapper (COM Wrapper) so that MATLAB does not release COM object
NET.enableAutoReleaseUnlock .NET object representing a RunTime Callable Wrapper (COM Wrapper) so that MATLAB releases COM object
Properties
NET.setStaticPropertyStatic property or field name
Events and Delegates
BeginInvokeInitiate asynchronous .NET delegate call
EndInvokeRetrieve result of asynchronous call initiated by .NET System.Delegate BeginInvoke method
CombineConvenience function for static .NET System.Delegate Combine method
RemoveConvenience function for static .NET System.Delegate Remove method
RemoveAllConvenience function for static .NET System.Delegate RemoveAll method
Enumerations
bitandBit-wise AND
bitorBit-wise OR
bitxorBit-wise XOR
bitnot.NET enumeration object bit-wise NOT instance method
Generic Classes
NET.convertArrayConvert numeric MATLAB array to .NET array
NET.createGenericCreate instance of specialized .NET generic type
NET.invokeGenericMethodInvoke generic method of object
NET.GenericClassRepresent parameterized generic type definitions

Call COM Objects

actxserverCreate COM server
actxcontrolCreate Microsoft ActiveX control in figure window
actxcontrollistList currently installed Microsoft ActiveX controls
actxcontrolselectCreate Microsoft ActiveX control from UI
eventlistenersList event handler functions associated with COM object events
methodsviewView class methods
registereventAssociate event handler for COM object event at run time
unregisteralleventsUnregister all event handlers associated with COM object events
unregistereventUnregister event handler associated with COM object event at run time
iscomDetermine whether input is COM or ActiveX object
iseventDetermine whether input is COM object event
isinterfaceDetermine whether input is COM interface
COMAccess COM components and ActiveX controls from MATLAB

Call Python Libraries

Getting Started with Python
pyversionChange default version of Python interpreter
pyargsCreate keyword argument for Python function
matlab.exception.PyExceptionCapture error information for Python exception
Data Types
pyargsCreate keyword argument for Python function
Functions
pyargsCreate keyword argument for Python function

Calling Web Services

HTTP Interface

matlab.net.http.RequestMessageHTTP request message
matlab.net.http.ResponseMessageHTTP response message
matlab.net.http.MessageHTTP request or response message
matlab.net.http.MessageTypeHTTP message type
matlab.net.http.MessageBodyBody of HTTP message
matlab.net.http.ProtocolVersionHTTP protocol version
matlab.net.http.RequestLineFirst line of HTTP request message
matlab.net.http.RequestMethodHTTP request method
matlab.net.http.StartLineFirst line of HTTP message
matlab.net.http.StatusClassStatus class of HTTP response
matlab.net.http.StatusCodeStatus code in HTTP response
matlab.net.http.StatusLineFirst line of HTTP response message
matlab.net.http.HeaderFieldHeader field of HTTP message
matlab.net.http.field.AcceptFieldHTTP Accept header field
matlab.net.http.field.AuthenticateFieldHTTP WWW-Authenticate or Proxy-Authenticate header field
matlab.net.http.field.AuthenticationInfoFieldHTTP Authentication-Info header field in response message
matlab.net.http.field.AuthorizationFieldHTTP Authorization or Proxy-Authorization header field
matlab.net.http.field.ContentLengthFieldHTTP Content-Length field
matlab.net.http.field.ContentLocationFieldHTTP Content-Location header field
matlab.net.http.field.ContentTypeFieldHTTP Content-Type header field
matlab.net.http.field.CookieFieldHTTP Cookie header field
matlab.net.http.field.DateFieldHTTP Date header field
matlab.net.http.field.GenericFieldHTTP header field with any name and value
matlab.net.http.field.HTTPDateFieldHTTP header field containing date
matlab.net.http.field.IntegerFieldBase class for HTTP header fields containing nonnegative integers
matlab.net.http.field.LocationFieldHTTP Location header field
matlab.net.http.field.MediaRangeFieldBase class for HTTP Content-Type and Accept header fields
matlab.net.http.field.SetCookieFieldHTTP Set-Cookie header field
matlab.net.http.field.URIReferenceFieldBase class for HTTP header fields containing URI components
matlab.net.http.AuthenticationSchemeHTTP Authentication scheme
matlab.net.http.AuthInfoAuthentication or authorization information in HTTP messages
matlab.net.http.CookieHTTP cookie received from server
matlab.net.http.CookieInfoHTTP cookie information
matlab.net.http.CredentialsCredentials for authenticating HTTP requests
matlab.net.http.DispositionResults in HTTP log record
matlab.net.http.HTTPExceptionException thrown by HTTP services
matlab.net.http.HTTPOptionsOptions controlling HTTP message exchange
matlab.net.http.LogRecordHTTP history log record
matlab.net.http.MediaTypeInternet media type used in HTTP headers
matlab.net.http.ProgressMonitorProgress monitor for HTTP message exchange
matlab.net.URIUniform resource identifier (URI)
matlab.net.ArrayFormatConvert arrays in HTTP queries
matlab.net.QueryParameterParameter in query portion of uniform resource identifier (URI)
matlab.net.base64decodeBase 64 decoding of string
matlab.net.base64encodeBase 64 encoding of byte string or vector

WSDL (Web Services Description Language)

matlab.wsdl.createWSDLClientCreate interface to SOAP-based web service
matlab.wsdl.setWSDLToolPathLocation of WSDL tools

Toolbox Distribution

matlab.addons.toolbox.packageToolboxPackage toolbox project
matlab.addons.toolbox.toolboxVersionQuery or modify version of toolbox
matlab.addons.toolbox.installToolboxInstall toolbox file
matlab.addons.toolbox.uninstallToolboxUninstall toolbox
matlab.addons.toolbox.installedToolboxesReturn information about installed toolboxes
builddocsearchdbBuild searchable documentation database
matlab.codetools.requiredFilesAndProductsList dependencies of MATLAB program files

Exception Handling

try, catchExecute statements and catch resulting errors
MExceptionCapture error information
addCauseRecord additional causes of exception
getReportGet error message for exception
lastReturn last uncaught exception
rethrowRethrow previously caught exception
throwThrow exception
throwAsCallerThrow exception as if occurs within calling function

Testing Frameworks

Script-Based Unit Tests

assertThrow error if condition false
runtestsRun set of tests
testsuiteCreate suite of tests
TestResultResult of running test suite

Function-Based Unit Tests

functiontestsCreate array of tests from handles to local functions
runtestsRun set of tests
testsuiteCreate suite of tests
TestSuite.runRun TestSuite array using TestRunner object configured for text output
TestSpecification of a single test method
FunctionTestCaseTestCase used for function-based tests
TestResultResult of running test suite

Class-Based Unit Tests

runtestsRun set of tests
testsuiteCreate suite of tests
matlab.unittest.TestSuite.runRun TestSuite array using TestRunner object configured for text output
matlab.unittest.TestRunner.runRun all tests in TestSuite array
matlab.unittest.TestCaseSuperclass of all matlab.unittest test classes
matlab.unittest.TestSuiteClass for grouping tests to run
matlab.unittest.TestSpecification of a single test method
matlab.unittest.TestRunnerClass for running tests in matlab.unittest framework
matlab.unittest.TestResultResult of running test suite

Extend Unit Testing Framework

matlab.unittest.constraints.ConstraintFundamental interface class for comparisons
matlab.unittest.constraints.BooleanConstraintInterface class for boolean combinations of constraints
matlab.unittest.constraints.ToleranceAbstract interface class for tolerances
matlab.unittest.fixtures.FixtureInterface class for test fixtures
matlab.unittest.diagnostics.DiagnosticFundamental interface class for matlab.unittest diagnostics
matlab.unittest.diagnostics.ConstraintDiagnosticDiagnostics specific to matlab.unittest constraints
matlab.unittest.plugins.TestRunnerPluginPlugin interface for extending TestRunner
matlab.unittest.plugins.QualifyingPluginInterface for plugins that perform system-wide qualifications
matlab.unittest.plugins.OutputStreamInterface that determines where to send text output

Performance Testing Framework

runperfRun set of tests for performance measurement
testsuiteCreate suite of tests
matlab.perftest.TimeExperimentInterface for measuring execution time of code under test
matlab.perftest.FixedTimeExperimentTimeExperiment that collects fixed number of measurements
matlab.perftest.FrequentistTimeExperimentTimeExperiment that collects variable number of measurements
matlab.perftest.TestCaseSuperclass of matlab.perftest performance test classes
matlab.unittest.measurement.MeasurementResultResult of measuring test suite

Mocking Framework

matlab.mock.TestCaseTestCase to write tests with mocking framework
matlab.mock.AnyArgumentsMatch any number of arguments
matlab.mock.actions.AssignOutputsDefine return values for method called or property accessed
matlab.mock.actions.ReturnStoredValueReturn stored property value
matlab.mock.actions.StoreValueStore property value
matlab.mock.actions.ThrowExceptionThrow exception when method is called or when property is set or accessed
matlab.mock.constraints.WasAccessedConstraint determining property get access
matlab.mock.constraints.WasCalledConstraint determining method call
matlab.mock.constraints.WasSetConstraint determining property set interaction
matlab.mock.MethodCallBehaviorSpecify mock object method behavior and qualify method calls
matlab.mock.PropertyBehaviorSpecify mock object property behavior and qualify interactions
matlab.mock.PropertyGetBehaviorSpecify mock property get behavior
matlab.mock.PropertySetBehaviorSpecify mock object set behavior

Performance and Memory

timeitMeasure time required to run function
ticStart stopwatch timer
tocRead elapsed time from stopwatch
cputimeElapsed CPU time
profileProfile execution time for functions
benchMATLAB benchmark
memoryDisplay memory information
inmemNames of functions, MEX-files, classes in memory
packConsolidate workspace memory
memoizeAdd memoization semantics to function handle
MemoizedFunctionCall memoized function and cache results
clearAllMemoizedCachesClear caches for all MemoizedFunction objects

System Commands

clipboardCopy and paste text to and from system clipboard
computerInformation about computer on which MATLAB is running
systemExecute operating system command and return output
dosExecute DOS command and return output
unixExecute UNIX command and return output
getenvEnvironment variable
setenvSet environment variable
perlCall Perl script using operating system executable
winqueryregItem from Windows registry
commandhistoryOpen Command History window, or select it if already open
commandwindowOpen Command Window, or select it if already open
filebrowserOpen Current Folder browser, or select it if already open
workspaceOpen Workspace browser to manage workspace
matlab.io.saveVariablesToScriptSave workspace variables to MATLAB script
getprefPreference
setprefSet preference
addprefAdd preference
rmprefRemove preference
isprefTest for existence of preference
matlab.addons.installedAddonsGet list of installed add-ons
matlab.addons.isAddonEnabledDetermine if add-on is enabled
matlab.addons.enableAddonEnable installed add-on
matlab.addons.disableAddonDisable installed add-on

MATLAB API for Other Languages

MATLAB Engine Applications

MATLAB API for Java
matlab.engine.shareEngineConvert running MATLAB session to shared session
matlab.engine.engineNameReturn name of shared MATLAB session
matlab.engine.isEngineSharedDetermine if MATLAB session is shared
com.mathworks.engine.MatlabEngineJava class using MATLAB as a computational engine
com.mathworks.matlab.types.ComplexJava class to pass complex data to and from MATLAB
com.mathworks.matlab.types.StructJava class to pass MATLAB struct to and from MATLAB
com.mathworks.matlab.types.CellStrJava class to represent MATLAB cell array of char vectors
com.mathworks.matlab.types.HandleObjectJava class to represent MATLAB handle objects
MATLAB API for Python
matlab.engine.start_matlabStart MATLAB Engine for Python
matlab.engine.find_matlabFind shared MATLAB sessions to connect to MATLAB Engine for Python
matlab.engine.connect_matlabConnect shared MATLAB session to MATLAB Engine for Python
matlab.engine.shareEngineConvert running MATLAB session to shared session
matlab.engine.engineNameReturn name of shared MATLAB session
matlab.engine.isEngineSharedDetermine if MATLAB session is shared
matlab.engine.MatlabEnginePython object using MATLAB as computational engine within Python session
matlab.engine.FutureResultResults of asynchronous call to MATLAB function stored in Python object
MATLAB API for C
mexBuild MEX function from C/C++ or Fortran source code
MATLAB API for Fortran
mexBuild MEX function from C/C++ or Fortran source code
MATLAB API for COM Automation Server
actxGetRunningServerHandle to running instance of Automation server
enableserviceEnable, disable, or report status of MATLAB Automation server
ExecuteExecute MATLAB command in Automation server
FevalEvaluate MATLAB function in Automation server
GetCharArrayCharacter array from Automation server
GetFullMatrixMatrix from Automation server workspace
GetVariableData from variable in Automation server workspace
GetWorkspaceDataData from Automation server workspace
MaximizeCommandWindowOpen Automation server window
MinimizeCommandWindowMinimize size of Automation server window
PutCharArrayStore character array in Automation server
PutFullMatrixMatrix in Automation server workspace
PutWorkspaceDataData in Automation server workspace
QuitTerminate MATLAB Automation server
regmatlabserverRegister current MATLAB as Automation server

MEX File Applications

C MEX Files
Executable C MEX Files
mexBuild MEX function from C/C++ or Fortran source code
dbmexEnable MEX-file debugging on UNIX platforms
mex.getCompilerConfigurationsGet compiler configuration information for building MEX files
Share MEX Files
verVersion information for MathWorks products
computerInformation about computer on which MATLAB is running
mexextBinary MEX file-name extension
mex.getCompilerConfigurationsGet compiler configuration information for building MEX files
Troubleshoot MEX Files
dbmexEnable MEX-file debugging on UNIX platforms
inmemNames of functions, MEX-files, classes in memory
mexBuild MEX function from C/C++ or Fortran source code
mexextBinary MEX file-name extension

Desktop Environment

Startup and Shutdown

matlab (Windows)Start MATLAB program from Windows system prompt
matlab (Mac)Start MATLAB program from macOS Terminal
matlab (Linux)Start MATLAB program from Linux system prompt
exitTerminate MATLAB program (same as quit)Desktop Tools and Development Environment.Startup and Shutdown
quitTerminate MATLAB program
matlabrcStart up file for MATLAB program
startupStart up file for user-defined options
finishTermination file for MATLAB program

Basic Settings

prefdirFolder containing preferences, history, and layout files
preferencesOpen Preferences dialog box

Platform and License

versionVersion number for MATLAB and libraries
verVersion information for MathWorks products
verLessThanCompare toolbox version to specified character vector
licenseGet license number or perform licensing task
ispcDetermine if version is for Windows (PC) platform
ismacDetermine if version is for macOS platform
isunixDetermine if version is for Linux or Mac platforms
isstudentDetermine if version is Student Version
javachkError message based on Java feature support
usejavaDetermine if Java feature is available

Help and Support

docReference page in Help browser
helpHelp for functions in Command Window
docsearchHelp browser search
lookforSearch for keyword in all help entries
demoAccess product examples in Help browser
echodemoRun example script step-by-step in Command Window
Was this topic helpful?