Function Reference


Bitwise FunctionsOperate on and manipulate bits
Constructor and Property FunctionsCreate and manipulate objects and properties
Data Manipulation FunctionsManipulate and get information about objects
Data Type FunctionsConvert objects or values to different data types
Data Quantizing FunctionsQuantize data
Element-Wise Logical Operator FunctionsGet information about array elements
Math Operation FunctionsOperate on objects
Matrix Manipulation FunctionsManipulate and get information about arrays
Plotting FunctionsCreate plots
Radix Conversion FunctionsBinary point representations and conversions
Relational Operator FunctionsCompare real-world values of objects
Statistics FunctionsGet statistical information about objects
Subscripted Assignment and Reference FunctionsGet and set array elements
fi Object FunctionsAll functions that operate directly on fi objects
fimath Object FunctionsAll functions that operate directly on fimath objects
fipref Object FunctionsAll functions that operate directly on fipref objects
numerictype Object FunctionsAll functions that operate directly on numerictype objects
quantizer Object FunctionsAll functions that operate directly on quantizer objects

Bitwise Functions

bitandBitwise AND of two fi objects
bitandreduceBitwise AND of consecutive range of bits
bitcmpBitwise complement of fi object
bitconcatConcatenate bits of fi objects
bitgetBit at certain position
bitorBitwise OR of two fi objects
bitorreduceBitwise OR of consecutive range of bits
bitreplicateReplicate and concatenate bits of a fi object
bitrolBitwise rotate left
bitrorBitwise rotate right
bitsetSet bit at certain position
bitshiftShift bits specified number of places
bitslicegetConsecutive slice of bits
bitsllBit shift left logical
bitsraBit shift right arithmetic
bitsrlBit shift right logical
bitxorBitwise exclusive OR of two fi objects
bitxorreduceBitwise exclusive OR of consecutive range of bits
getlsbLeast significant bit
getmsbMost significant bit

Constructor and Property Functions

assignmentquantizerAssignment quantizer object of fi object
copyobjMake independent copy of quantizer object
fiConstruct fi object
fimathConstruct fimath object
fiprefConstruct fipref object
getProperty values of object
numerictypeConstruct numerictype object
quantizerConstruct quantizer object
resetReset objects to initial conditions
savefiprefSave fi preferences for next MATLAB® session
setSet or display property values for quantizer objects
stripscalingStored integer of fi object
tostringConvert numerictype or quantizer object to string
unitquantizerConstructor for unitquantizer object

Data Manipulation Functions

assignmentquantizerAssignment quantizer object of fi object
denormalmaxLargest denormalized quantized number for quantizer object
denormalminSmallest denormalized quantized number for quantizer object
epsQuantized relative accuracy for fi or quantizer objects
exponentbiasExponent bias for quantizer object
exponentlengthExponent length of quantizer object
exponentmaxMaximum exponent for quantizer object
exponentminMinimum exponent for quantizer object
fractionlengthFraction length of quantizer object
intmaxLargest positive stored integer value representable by numerictype of fi object
intminSmallest stored integer value representable by numerictype of fi object
isbooleanDetermine whether input is Boolean
isdoubleDetermine whether input is double-precision data type
isequalDetermine whether real-world values of two fi objects are equal, or determine whether properties of two fimath, numerictype, or quantizer objects are equal
isfiDetermine whether variable is fi object
isfimathDetermine whether variable is fimath object
isfiprefDetermine whether input is fipref object
isfixedDetermine whether input is fixed-point data type
isfloatDetermine whether input is floating-point data type
isnumerictypeDetermine whether input is numerictype object
ispropequalDetermine whether properties of two fi objects are equal
isquantizerDetermine whether input is quantizer object
isscaleddoubleDetermine whether input is scaled double data type
isscaledtypeDetermine whether input is fixed-point or scaled double data type
issignedDetermine whether fi object is signed
issingleDetermine whether input is single-precision data type
isslopebiasscaledDetermine whether numerictype object has nontrivial slope and bias
lowerboundLower bound of range of fi object
lsbScaling of least significant bit of fi object, or value of least significant bit of quantizer object
rangeNumerical range of fi or quantizer object
realmaxLargest positive fixed-point value or quantized number
realminSmallest positive normalized fixed-point value or quantized number
rescaleChange scaling of fi object
upperboundUpper bound of range of fi object
wordlengthWord length of quantizer object

Data Type Functions

doubleDouble-precision floating-point real-world value of fi object
intSmallest built-in integer fitting stored integer value of fi object
int16Stored integer value of fi object as built-in int16
int32Stored integer value of fi object as built-in int32
int8Stored integer value of fi object as built-in int8
logicalConvert numeric values to logical
singleSingle-precision floating-point real-world value of fi object
uint16Stored integer value of fi object as built-in uint16
uint32Stored integer value of fi object as built-in uint32
uint8Stored integer value of fi object as built-in uint8

Data Quantizing Functions

convergentApply convergent rounding
quantizeApply quantizer object to data
randquantGenerate uniformly distributed, quantized random number using quantizer object
roundRound fi object toward nearest integer or round input data using quantizer object
unitquantizeQuantize except numbers within eps of +1
unitquantizerConstructor for unitquantizer object

Element-Wise Logical Operator Functions

allDetermine whether all array elements are nonzero
andFind logical AND of array or scalar inputs
anyDetermine whether any array elements are nonzero
notFind logical NOT of array or scalar input
orFind logical OR of array or scalar inputs

Math Operation Functions

absAbsolute value of fi object
addAdd two objects using fimath object
ceilRound toward positive infinity
complexConstruct complex fi object from real and imaginary parts
conjComplex conjugate of fi object
divideDivide two objects
fixRound toward zero
floorRound toward negative infinity
imagImaginary part of complex number
innerprodintbitsNumber of integer bits needed for fixed-point inner product
minusMatrix difference between fi objects
mpyMultiply two objects using fimath object
mtimesMatrix product of fi objects
nearestRound toward nearest integer with ties rounding toward positive infinity
plusMatrix sum of fi objects
pow2Multiply by 2K
realReal part of complex number
roundRound fi object toward nearest integer or round input data using quantizer object
signPerform signum function on array
sqrtSquare root of fi object
subSubtract two objects using fimath object
sumSum of array elements
timesElement-by-element multiplication of fi objects
uminusNegate elements of fi object array
uplusUnary plus

Matrix Manipulation Functions

bufferBuffer signal vector into matrix of data frames
ctransposeComplex conjugate transpose of fi object
diagDiagonal matrices or diagonals of matrix
dispDisplay object
endLast index of array
flipdimFlip array along specified dimension
fliplrFlip matrix left to right
flipudFlip matrix up to down
hankelHankel matrix
horzcatHorizontally concatenate multiple fi objects
ipermuteInverse permute dimensions of multidimensional array
iscolumnDetermine whether fi object is column vector
isemptyDetermine whether array is empty
isfiniteDetermine whether array elements are finite
isinfDetermine whether array elements are infinite
isnanDetermine whether array elements are NaN
isnumericDetermine whether input is numeric array
isobjectDetermine whether input is MATLAB® OOPS object
isrealDetermine whether array elements are real
isrowDetermine whether fi object is row vector
isscalarDetermine whether input is scalar
isvectorDetermine whether input is vector
lengthVector length
ndimsNumber of array dimensions
permuteRearrange dimensions of multidimensional array
repmatReplicate and tile array
reshapeReshape array
shiftdataShift data to operate on specified dimension
shiftdimShift dimensions
sizeArray dimensions
squeezeRemove singleton dimensions
toeplitzCreate Toeplitz matrix
transposeTranspose operation
trilLower triangular part of matrix
unshiftdataInverse of shiftdata
vertcatVertically concatenate multiple fi objects
xorLogical exclusive-OR

Plotting Functions

areaCreate filled area 2-D plot
barCreate vertical bar graph
barhCreate horizontal bar graph
clabelCreate contour plot elevation labels
cometCreate 2-D comet plot
comet3Create 3-D comet plot
compassPlot arrows emanating from origin
coneplotPlot velocity vectors as cones in 3-D vector field
contourCreate contour graph of matrix
contour3Create 3-D contour plot
contourcCreate two-level contour plot computation
contourfCreate filled 2-D contour plot
errorbarPlot error bars along curve
etreeplotPlot elimination tree
ezcontourEasy-to-use contour plotter
ezcontourfEasy-to-use filled contour plotter
ezmeshEasy-to-use 3-D mesh plotter
ezplotEasy-to-use function plotter
ezplot3Easy-to-use 3-D parametric curve plotter
ezpolarEasy-to-use polar coordinate plotter
ezsurfEasy-to-use 3-D colored surface plotter
ezsurfcEasy-to-use combination surface/contour plotter
featherPlot velocity vectors
fplotPlot function between specified limits
gplotPlot set of nodes using adjacency matrix
histCreate histogram plot
histcHistogram count
isslopebiasscaledDetermine whether numerictype object has nontrivial slope and bias
lineCreate line object
loglogCreate log-log scale plot
meshCreate mesh plot
meshcCreate mesh plot with contour plot
meshzCreate mesh plot with curtain plot
ndgridGenerate arrays for N-D functions and interpolation
patchCreate patch graphics object
pcolorCreate pseudocolor plot
plotCreate linear 2-D plot
plot3Create 3-D line plot
plotmatrixDraw scatter plots
plotyyCreate graph with y-axes on right and left sides
polarPlot polar coordinates
quiverCreate quiver or velocity plot
quiver3Create 3-D quiver or velocity plot
rgbplotPlot colormap
ribbonCreate ribbon plot
roseCreate angle histogram
scatterCreate scatter or bubble plot
scatter3Create 3-D scatter or bubble plot
semilogxCreate semilogarithmic plot with logarithmic x-axis
semilogyCreate semilogarithmic plot with logarithmic y-axis
sliceCreate volumetric slice plot
spyVisualize sparsity pattern
stairsCreate stairstep graph
stemPlot discrete sequence data
stem3Plot 3-D discrete sequence data
streamribbonCreate 3-D stream ribbon plot
streamsliceDraw streamlines in slice planes
streamtubeCreate 3-D stream tube plot
surfCreate 3-D shaded surface plot
surfcCreate 3-D shaded surface plot with contour plot
surflCreate surface plot with colormap-based lighting
surfnormCompute and display 3-D surface normals
textCreate text object in current axes
treeplotPlot picture of tree
trimeshCreate triangular mesh plot
triplotCreate 2-D triangular plot
trisurfCreate triangular surface plot
triuUpper triangular part of matrix
voronoiCreate Voronoi diagram
voronoinCreate n-D Voronoi diagram
waterfallCreate waterfall plot
xlimSet or query x-axis limits
ylimSet or query y-axis limits
zlimSet or query z-axis limits

Radix Conversion Functions

binBinary representation of stored integer of fi object
bin2numConvert two's complement binary string to number using quantizer object
decUnsigned decimal representation of stored integer of fi object
hexHexadecimal representation of stored integer of fi object
hex2numConvert hexadecimal string to number using quantizer object
num2binConvert number to binary string using quantizer object
num2hexConvert number to hexadecimal equivalent using quantizer object
num2intConvert number to signed integer
octOctal representation of stored integer of fi object
sdecSigned decimal representation of stored integer of fi object

Relational Operator Functions

eqDetermine whether real-world values of two fi objects are equal
geDetermine whether real-world value of one fi object is greater than or equal to another
gtDetermine whether real-world value of one fi object is greater than another
leDetermine whether real-world value of fi object is less than or equal to another
ltDetermine whether real-world value of one fi object is less than another
neDetermine whether real-world values of two fi objects are not equal

Statistics Functions

errmeanMean of quantization error
errpdfProbability density function of quantization error
errvarVariance of quantization error
logreportQuantization report
maxLargest element in array of fi objects
maxlogLog maximums
minSmallest element in array of fi objects
minlogLog minimums
noperationsNumber of operations
noverflowsNumber of overflows
numberofelementsNumber of data elements in fi array
nunderflowsNumber of underflows
resetlogClear log for fi or quantizer object

Subscripted Assignment and Reference Functions

subsasgnSubscripted assignment
subsrefSubscripted reference

fi Object Functions

absAbsolute value of fi object
allDetermine whether all array elements are nonzero
andFind logical AND of array or scalar inputs
anyDetermine whether any array elements are nonzero
areaCreate filled area 2-D plot
assignmentquantizerAssignment quantizer object of fi object
barCreate vertical bar graph
barhCreate horizontal bar graph
binBinary representation of stored integer of fi object
bitandBitwise AND of two fi objects
bitandreduceBitwise AND of consecutive range of bits
bitcmpBitwise complement of fi object
bitconcatConcatenate bits of fi objects
bitgetBit at certain position
bitorBitwise OR of two fi objects
bitorreduceBitwise OR of consecutive range of bits
bitreplicateReplicate and concatenate bits of a fi object
bitrolBitwise rotate left
bitrorBitwise rotate right
bitsetSet bit at certain position
bitshiftShift bits specified number of places
bitslicegetConsecutive slice of bits
bitsllBit shift left logical
bitsraBit shift right arithmetic
bitsrlBit shift right logical
bitxorBitwise exclusive OR of two fi objects
bitxorreduceBitwise exclusive OR of consecutive range of bits
bufferBuffer signal vector into matrix of data frames
ceilRound toward positive infinity
clabelCreate contour plot elevation labels
cometCreate 2-D comet plot
comet3Create 3-D comet plot
compassPlot arrows emanating from origin
complexConstruct complex fi object from real and imaginary parts
coneplotPlot velocity vectors as cones in 3-D vector field
conjComplex conjugate of fi object
contourCreate contour graph of matrix
contour3Create 3-D contour plot
contourcCreate two-level contour plot computation
contourfCreate filled 2-D contour plot
ctransposeComplex conjugate transpose of fi object
decUnsigned decimal representation of stored integer of fi object
diagDiagonal matrices or diagonals of matrix
dispDisplay object
doubleDouble-precision floating-point real-world value of fi object
endLast index of array
epsQuantized relative accuracy for fi or quantizer objects
eqDetermine whether real-world values of two fi objects are equal
errorbarPlot error bars along curve
etreeplotPlot elimination tree
ezcontourEasy-to-use contour plotter
ezcontourfEasy-to-use filled contour plotter
ezmeshEasy-to-use 3-D mesh plotter
ezplotEasy-to-use function plotter
ezplot3Easy-to-use 3-D parametric curve plotter
ezpolarEasy-to-use polar coordinate plotter
ezsurfEasy-to-use 3-D colored surface plotter
ezsurfcEasy-to-use combination surface/contour plotter
featherPlot velocity vectors
fiConstruct fi object
fimathConstruct fimath object
fixRound toward zero
flipdimFlip array along specified dimension
fliplrFlip matrix left to right
flipudFlip matrix up to down
floorRound toward negative infinity
fplotPlot function between specified limits
geDetermine whether real-world value of one fi object is greater than or equal to another
getProperty values of object
getlsbLeast significant bit
getmsbMost significant bit
gplotPlot set of nodes using adjacency matrix
gtDetermine whether real-world value of one fi object is greater than another
hankelHankel matrix
hexHexadecimal representation of stored integer of fi object
histCreate histogram plot
histcHistogram count
horzcatHorizontally concatenate multiple fi objects
imagImaginary part of complex number
innerprodintbitsNumber of integer bits needed for fixed-point inner product
intSmallest built-in integer fitting stored integer value of fi object
int16Stored integer value of fi object as built-in int16
int32Stored integer value of fi object as built-in int32
int8Stored integer value of fi object as built-in int8
intmaxLargest positive stored integer value representable by numerictype of fi object
intminSmallest stored integer value representable by numerictype of fi object
ipermuteInverse permute dimensions of multidimensional array
isbooleanDetermine whether input is Boolean
iscolumnDetermine whether fi object is column vector
isdoubleDetermine whether input is double-precision data type
isemptyDetermine whether array is empty
isequalDetermine whether real-world values of two fi objects are equal, or determine whether properties of two fimath, numerictype, or quantizer objects are equal
isfiDetermine whether variable is fi object
isfiniteDetermine whether array elements are finite
isfixedDetermine whether input is fixed-point data type
isfloatDetermine whether input is floating-point data type
isinfDetermine whether array elements are infinite
isnanDetermine whether array elements are NaN
isnumericDetermine whether input is numeric array
isobjectDetermine whether input is MATLAB® OOPS object
ispropequalDetermine whether properties of two fi objects are equal
isrealDetermine whether array elements are real
isrowDetermine whether fi object is row vector
isscalarDetermine whether input is scalar
isscaleddoubleDetermine whether input is scaled double data type
isscaledtypeDetermine whether input is fixed-point or scaled double data type
issignedDetermine whether fi object is signed
issingleDetermine whether input is single-precision data type
isvectorDetermine whether input is vector
leDetermine whether real-world value of fi object is less than or equal to another
lengthVector length
lineCreate line object
logicalConvert numeric values to logical
loglogCreate log-log scale plot
logreportQuantization report
lowerboundLower bound of range of fi object
lsbScaling of least significant bit of fi object, or value of least significant bit of quantizer object
ltDetermine whether real-world value of one fi object is less than another
maxLargest element in array of fi objects
maxlogLog maximums
meshCreate mesh plot
meshcCreate mesh plot with contour plot
meshzCreate mesh plot with curtain plot
minSmallest element in array of fi objects
minlogLog minimums
minusMatrix difference between fi objects
mtimesMatrix product of fi objects
ndgridGenerate arrays for N-D functions and interpolation
ndimsNumber of array dimensions
neDetermine whether real-world values of two fi objects are not equal
nearestRound toward nearest integer with ties rounding toward positive infinity
notFind logical NOT of array or scalar input
noverflowsNumber of overflows
numberofelementsNumber of data elements in fi array
numerictypeConstruct numerictype object
nunderflowsNumber of underflows
octOctal representation of stored integer of fi object
orFind logical OR of array or scalar inputs
patchCreate patch graphics object
pcolorCreate pseudocolor plot
permuteRearrange dimensions of multidimensional array
plotCreate linear 2-D plot
plot3Create 3-D line plot
plotmatrixDraw scatter plots
plotyyCreate graph with y-axes on right and left sides
plusMatrix sum of fi objects
polarPlot polar coordinates
pow2Multiply by 2K
quantizerConstruct quantizer object
quiverCreate quiver or velocity plot
quiver3Create 3-D quiver or velocity plot
rangeNumerical range of fi or quantizer object
realReal part of complex number
realmaxLargest positive fixed-point value or quantized number
realminSmallest positive normalized fixed-point value or quantized number
repmatReplicate and tile array
rescaleChange scaling of fi object
resetlogClear log for fi or quantizer object
reshapeReshape array
rgbplotPlot colormap
ribbonCreate ribbon plot
roseCreate angle histogram
roundRound fi object toward nearest integer or round input data using quantizer object
scatterCreate scatter or bubble plot
scatter3Create 3-D scatter or bubble plot
sdecSigned decimal representation of stored integer of fi object
semilogxCreate semilogarithmic plot with logarithmic x-axis
semilogyCreate semilogarithmic plot with logarithmic y-axis
shiftdataShift data to operate on specified dimension
shiftdimShift dimensions
signPerform signum function on array
singleSingle-precision floating-point real-world value of fi object
sizeArray dimensions
sliceCreate volumetric slice plot
spyVisualize sparsity pattern
sqrtSquare root of fi object
squeezeRemove singleton dimensions
stairsCreate stairstep graph
stemPlot discrete sequence data
stem3Plot 3-D discrete sequence data
streamribbonCreate 3-D stream ribbon plot
streamsliceDraw streamlines in slice planes
streamtubeCreate 3-D stream tube plot
stripscalingStored integer of fi object
subsasgnSubscripted assignment
subsrefSubscripted reference
sumSum of array elements
surfCreate 3-D shaded surface plot
surfcCreate 3-D shaded surface plot with contour plot
surflCreate surface plot with colormap-based lighting
surfnormCompute and display 3-D surface normals
textCreate text object in current axes
timesElement-by-element multiplication of fi objects
toeplitzCreate Toeplitz matrix
transposeTranspose operation
treeplotPlot picture of tree
trilLower triangular part of matrix
trimeshCreate triangular mesh plot
triplotCreate 2-D triangular plot
trisurfCreate triangular surface plot
triuUpper triangular part of matrix
uint16Stored integer value of fi object as built-in uint16
uint32Stored integer value of fi object as built-in uint32
uint8Stored integer value of fi object as built-in uint8
uminusNegate elements of fi object array
unshiftdataInverse of shiftdata
uplusUnary plus
upperboundUpper bound of range of fi object
vertcatVertically concatenate multiple fi objects
voronoiCreate Voronoi diagram
voronoinCreate n-D Voronoi diagram
waterfallCreate waterfall plot
xlimSet or query x-axis limits
xorLogical exclusive-OR
ylimSet or query y-axis limits
zlimSet or query z-axis limits

fimath Object Functions

addAdd two objects using fimath object
dispDisplay object
fimathConstruct fimath object
isequalDetermine whether real-world values of two fi objects are equal, or determine whether properties of two fimath, numerictype, or quantizer objects are equal
isfimathDetermine whether variable is fimath object
mpyMultiply two objects using fimath object
sqrtSquare root of fi object
subSubtract two objects using fimath object

fipref Object Functions

dispDisplay object
fiprefConstruct fipref object
isfiprefDetermine whether input is fipref object
resetReset objects to initial conditions
savefiprefSave fi preferences for next MATLAB® session

numerictype Object Functions

dispDisplay object
divideDivide two objects
isbooleanDetermine whether input is Boolean
isdoubleDetermine whether input is double-precision data type
isequalDetermine whether real-world values of two fi objects are equal, or determine whether properties of two fimath, numerictype, or quantizer objects are equal
isfixedDetermine whether input is fixed-point data type
isfloatDetermine whether input is floating-point data type
isnumerictypeDetermine whether input is numerictype object
isscaleddoubleDetermine whether input is scaled double data type
isscaledtypeDetermine whether input is fixed-point or scaled double data type
issingleDetermine whether input is single-precision data type
isslopebiasscaledDetermine whether numerictype object has nontrivial slope and bias
sqrtSquare root of fi object
tostringConvert numerictype or quantizer object to string

quantizer Object Functions

bin2numConvert two's complement binary string to number using quantizer object
copyobjMake independent copy of quantizer object
denormalmaxLargest denormalized quantized number for quantizer object
denormalminSmallest denormalized quantized number for quantizer object
dispDisplay object
epsQuantized relative accuracy for fi or quantizer objects
errmeanMean of quantization error
errpdfProbability density function of quantization error
errvarVariance of quantization error
exponentbiasExponent bias for quantizer object
exponentlengthExponent length of quantizer object
exponentmaxMaximum exponent for quantizer object
exponentminMinimum exponent for quantizer object
fractionlengthFraction length of quantizer object
getProperty values of object
hex2numConvert hexadecimal string to number using quantizer object
isequalDetermine whether real-world values of two fi objects are equal, or determine whether properties of two fimath, numerictype, or quantizer objects are equal
isfixedDetermine whether input is fixed-point data type
isfloatDetermine whether input is floating-point data type
isquantizerDetermine whether input is quantizer object
lengthVector length
lsbScaling of least significant bit of fi object, or value of least significant bit of quantizer object
maxLargest element in array of fi objects
maxlogLog maximums
minSmallest element in array of fi objects
minlogLog minimums
noperationsNumber of operations
noverflowsNumber of overflows
num2binConvert number to binary string using quantizer object
num2hexConvert number to hexadecimal equivalent using quantizer object
num2intConvert number to signed integer
nunderflowsNumber of underflows
quantizeApply quantizer object to data
quantizerConstruct quantizer object
randquantGenerate uniformly distributed, quantized random number using quantizer object
rangeNumerical range of fi or quantizer object
realmaxLargest positive fixed-point value or quantized number
realminSmallest positive normalized fixed-point value or quantized number
resetReset objects to initial conditions
resetlogClear log for fi or quantizer object
roundRound fi object toward nearest integer or round input data using quantizer object
setSet or display property values for quantizer objects
tostringConvert numerictype or quantizer object to string
unitquantizeQuantize except numbers within eps of +1
unitquantizerConstructor for unitquantizer object
wordlengthWord length of quantizer object
  


 © 1984-2008- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS