Documentation

Fixed-Point Designer Functions

Alphabetical List By Category
absAbsolute value of fi object
accumnegSubtract two fi objects or values
accumposAdd two fi objects or values
addAdd two objects using fimath 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
atan2Four-quadrant inverse tangent of fixed-point values
autofixexpAutomatically change scaling of fixed-point data types
barCreate vertical bar graph
barhCreate horizontal bar graph
binBinary representation of stored integer of fi object
bin2numConvert two's complement binary string to number using quantizer object
bitandBitwise AND of two fi objects
bitandreduceReduce consecutive slice of bits to one bit by performing bitwise AND operation
bitcmpBitwise complement of fi object
bitconcatConcatenate bits of fi objects
bitgetGet bits at certain positions
bitorBitwise OR of two fi objects
bitorreduceReduce consecutive slice of bits to one bit by performing bitwise OR operation
bitreplicateReplicate and concatenate bits of fi object
bitrolBitwise rotate left
bitrorBitwise rotate right
bitsetSet bits at certain positions
bitshiftShift bits specified number of places
bitslicegetGet consecutive slice of bits
bitsllBit shift left logical
bitsraBit shift right arithmetic
bitsrlBit shift right logical
bitxorBitwise exclusive OR of two fi objects
bitxorreduceReduce consecutive slice of bits to one bit by performing bitwise exclusive OR operation
bufferBuffer signal vector into matrix of data frames
buildInstrumentedMexGenerate compiled C code function including logging instrumentation
castCast variable to different data type
ceil Round toward positive infinity
clabelCreate contour plot elevation labels
clearInstrumentationResultsClear results logged by instrumented, compiled C code function
coder.allowpcodeControl code generation from protected MATLAB files
coder.approximationCreate function replacement configuration object
coder.ArrayTypeRepresent set of MATLAB arrays
coder.CellTypeRepresent set of MATLAB cell arrays
coder.ClassTypeRepresent set of MATLAB classes
coder.configCreate configuration object for fixed-point or single-precision conversion
coder.constFold expressions into constants in generated code
coder.ConstantRepresent set containing one MATLAB value
coder.cstructnameName structure in generated code
coder.EnumTypeRepresent set of MATLAB enumerations
coder.extrinsicDeclare extrinsic function or functions
coder.FiTypeRepresent set of MATLAB fixed-point arrays
coder.FixptConfigFloating-point to fixed-point conversion configuration object
coder.ignoreConstPrevent use of constant value of expression for function specializations
coder.inlineControl inlining in generated code
coder.loadLoad compile-time constants from MAT-file or ASCII file into caller workspace
coder.mexconfigCode acceleration configuration object
coder.MexConfigCode acceleration configuration object for use with fiaccel
coder.newtypeCreate a coder.Type object
coder.nullcopyDeclare uninitialized variables
coder.PrimitiveTypeRepresent set of logical, numeric, or char arrays
coder.resizeResize a coder.Type object
coder.screenerDetermine if function is suitable for code generation
coder.SingleConfigDouble-precision to single-precision conversion configuration object
coder.StructTypeRepresent set of MATLAB structure arrays
coder.targetDetermine if code generation target is specified target
coder.TypeRepresent set of MATLAB values
coder.typeofCreate coder.Type object to represent the type of an entry-point function input
coder.unrollUnroll for-loop by making a copy of the loop body for each loop iteration
coder.varsizeDeclare variable-size array
colonCreate vectors, array subscripting
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
convConvolution and polynomial multiplication of fi objects
convergentRound toward nearest integer with ties rounding to nearest even integer
convertToSingleConvert double-precision MATLAB code to single-precision MATLAB code
copyobjMake independent copy of quantizer object
cordicabsCORDIC-based absolute value
cordicangleCORDIC-based phase angle
cordicatan2CORDIC-based four quadrant inverse tangent
cordiccart2polCORDIC-based approximation of Cartesian-to-polar conversion
cordiccexpCORDIC-based approximation of complex exponential
cordiccosCORDIC-based approximation of cosine
cordicpol2cartCORDIC-based approximation of polar-to-Cartesian conversion
cordicrotateRotate input using CORDIC-based approximation
cordicsinCORDIC-based approximation of sine
cordicsincosCORDIC-based approximation of sine and cosine
cordicsqrtCORDIC-based approximation of square root
cordictanhCORDIC-based hyperbolic tangent
cosCosine of fi object
ctransposeComplex conjugate transpose of fi object
DataTypeWorkflow.ConverterCreate fixed-point converter object
DataTypeWorkflow.DiffRunResultResults from comparing two simulation runs
DataTypeWorkflow.DiffSignalResultResults from comparing two signals
DataTypeWorkflow.ProposalSettingsProposal settings object for data type proposals
DataTypeWorkflow.ResultObject containing run result information
DataTypeWorkflow.Single.convertToSingleConvert a double-precision system to single precision
decUnsigned decimal representation of stored integer of fi object
denormalmaxLargest denormalized quantized number for quantizer object
denormalminSmallest denormalized quantized number for quantizer object
diagDiagonal matrices or diagonals of matrix
dispDisplay object
divideDivide two objects
doubleDouble-precision floating-point real-world value of fi object
embedded.fiFixed-point numeric object
embedded.fimathfimath object
embedded.numerictypenumerictype object
endLast index of array
epsQuantized relative accuracy for fi or quantizer objects
eqDetermine whether real-world values of two fi objects are equal
errmeanMean of quantization error
errorbarPlot error bars along curve
errpdfProbability density function of quantization error
errvarVariance of quantization error
etreeplotPlot elimination tree
exponentbiasExponent bias for quantizer object
exponentlengthExponent length of quantizer object
exponentmaxMaximum exponent for quantizer object
exponentminMinimum exponent for quantizer object
eyeCreate identity matrix with fixed-point properties
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 fixed-point numeric object
fiaccelAccelerate fixed-point code and convert floating-point MATLAB code to fixed-point MATLAB code
filterOne-dimensional digital filter of fi objects
fimathSet fixed-point math settings
fiprefSet fixed-point preferences
fixRound toward zero
fixed.aggregateTypeCompute aggregate numerictype
fixed.QuantizerQuantize fixed-point numbers
fixpt_instrument_purgeRemove corrupt fixed-point instrumentation from model
flipFlip order of elements
fliplrFlip matrix left to right
flipudFlip matrix up to down
floorRound toward negative infinity
forExecute statements specified number of times
fplotPlot function between specified limits
fractionlengthFraction length of quantizer object
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
globalfimathConfigure global fimath and return handle object
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
hex2numConvert hexadecimal string to number using quantizer 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
int16Convert fi object to signed 16-bit integer
int32Convert fi object to signed 32-bit integer
int64Convert fi object to signed 64-bit integer
int8Convert fi object to signed 8-bit integer
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
isequivalentDetermine if two numerictype objects have equivalent properties
isfiDetermine whether variable is fi object
isfimathDetermine whether variable is fimath object
isfimathlocalDetermine whether fi object has local fimath
isfiniteDetermine whether array elements are finite
isfiprefDetermine whether input is fipref object
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
isnumerictypeDetermine whether input is numerictype object
isobjectDetermine whether input is MATLAB object
ispropequalDetermine whether properties of two fi objects are equal
isquantizerDetermine whether input is quantizer object
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
isscalingbinarypointDetermine whether input has binary point scaling
isscalingslopebiasDetermine whether input has nontrivial slope and bias scaling
isscalingunspecifiedDetermine whether input has unspecified scaling
issignedDetermine whether fi object is signed
issingleDetermine whether input is single-precision data type
isslopebiasscaledDetermine whether numerictype object has nontrivial slope and bias
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
mat2strConvert matrix to string
maxLargest element in array of fi objects
maxlogLog maximums
meanAverage or mean value of fixed-point array
medianMedian value of fixed-point array
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
modModulus after division for fi objects
mpowerFixed-point matrix power (^)
mpyMultiply two objects using fimath object
mrdivideForward slash (/) or right-matrix division
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
noperationsNumber of operations
notFind logical NOT of array or scalar input
noverflowsNumber of overflows
ntsDetermine fixed-point data type
num2binConvert number to binary representation using quantizer object
num2hexConvert number to hexadecimal equivalent using quantizer object
num2intConvert number to signed integer
numberofelementsNumber of data elements in an array
numelNumber of data elements in fi array
numerictypeConstruct numerictype object
NumericTypeScopeDetermine fixed-point data type
nunderflowsNumber of underflows
octOctal representation of stored integer of fi object
onesCreate array of all ones with fixed-point properties
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
pow2Efficient fixed-point multiplication by 2K
powerFixed-point array power (.^)
qrOrthogonal-triangular decomposition
quantizeQuantize fixed-point numbers
quantize methodApply quantizer object to data
quantizerConstruct quantizer object
quiverCreate quiver or velocity plot
quiver3Create 3-D quiver or velocity plot
randquantGenerate uniformly distributed, quantized random number using quantizer object
rangeNumerical range of fi or quantizer object
rdivideRight-array division (./)
realReal part of complex number
realmaxLargest positive fixed-point value or quantized number
realminSmallest positive normalized fixed-point value or quantized number
reinterpretcastConvert fixed-point data types without changing underlying data
removefimathRemove fimath object from fi object
removeglobalfimathprefRemove global fimath preference
repmatReplicate and tile array
rescaleChange scaling of fi object
resetReset objects to initial conditions
resetglobalfimathSet global fimath to MATLAB factory default
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
savefiprefSave fi preferences for next MATLAB session
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
setSet or display property values for quantizer objects
setfimathAttach fimath object to fi object
sfiConstruct signed fixed-point numeric object
shiftdataShift data to operate on specified dimension
shiftdimShift dimensions
showfixptsimerrorsShow overflows from most recent fixed-point simulation
showfixptsimrangesShow logged maximum values, minimum values, and overflow data from fixed-point simulation
showInstrumentationResultsResults logged by instrumented, compiled C code function
signPerform signum function on array
sinSine of fixed-point values
singleSingle-precision floating-point real-world value of fi object
sizeArray dimensions
sliceCreate volumetric slice plot
sortSort elements of real-valued fi object in ascending or descending order
spyVisualize sparsity pattern
sqrtSquare root of fi object
squeezeRemove singleton dimensions
ssFxpConvertConvert value from one data type to another
ssFxpConvertFromRealWorldValueConvert value of data type double to another data type
ssFxpConvertToRealWorldValueConvert value of any data type to double
ssFxpGetU32BitRegionReturn stored integer value for 32-bit region of real, scalar signal element
ssFxpGetU32BitRegionCompliantDetermine whether S-function is compliant with the U32 bit region interface
ssFxpSetU32BitRegionSet stored integer value for 32-bit region of real, scalar signal element
ssFxpSetU32BitRegionCompliantDeclare compliance with the U32 bit region interface for fixed-point data types with 33 or more bits
ssGetDataTypeBiasReturn bias of registered data type
ssGetDataTypeFixedExponentReturn exponent of slope of registered data type
ssGetDataTypeFracSlopeReturn fractional slope of registered data type
ssGetDataTypeFractionLengthReturn fraction length of registered data type with power-of-two scaling
ssGetDataTypeFxpContainWordLenReturn word length of storage container of registered data type
ssGetDataTypeFxpIsSignedDetermine whether fixed-point registered data type is signed or unsigned
ssGetDataTypeFxpWordLengthReturn word length of fixed-point registered data type
ssGetDataTypeIsFixedPointDetermine whether registered data type is fixed-point data type
ssGetDataTypeIsFloatingPointDetermine whether registered data type is floating-point data type
ssGetDataTypeIsFxpFltApiCompatDetermine whether registered data type is supported by API for user-written fixed-point S-functions
ssGetDataTypeIsScalingPow2Determine whether registered data type has power-of-two scaling
ssGetDataTypeIsScalingTrivialDetermine whether scaling of registered data type is slope = 1, bias = 0
ssGetDataTypeNumberOfChunksReturn number of chunks in multiword storage container of registered data type
ssGetDataTypeStorageContainCatReturn storage container category of registered data type
ssGetDataTypeStorageContainerSizeReturn storage container size of registered data type
ssGetDataTypeTotalSlopeReturn total slope of scaling of registered data type
ssLogFixptInstrumentationRecord information collected during simulation
ssRegisterDataTypeFxpBinaryPointRegister fixed-point data type with binary-point-only scaling and return its data type ID
ssRegisterDataTypeFxpFSlopeFixExpBiasRegister fixed-point data type with [Slope Bias] scaling specified in terms of fractional slope, fixed exponent, and bias, and return its data type ID
ssRegisterDataTypeFxpScaledDoubleRegister scaled double data type with [Slope Bias] scaling specified in terms of fractional slope, fixed exponent, and bias, and return its data type ID
ssRegisterDataTypeFxpSlopeBiasRegister data type with [Slope Bias] scaling and return its data type ID
stairsCreate stairstep graph
stemPlot discrete sequence data
stem3Plot 3-D discrete sequence data
storedIntegerStored integer value of fi object
storedIntegerToDoubleConvert stored integer value of fi object to built-in double value
streamribbonCreate 3-D stream ribbon plot
streamsliceDraw streamlines in slice planes
streamtubeCreate 3-D stream tube plot
stripscalingStored integer of fi object
subSubtract two objects using fimath 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
tostringConvert numerictype or quantizer object to string
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
ufiConstruct unsigned fixed-point numeric object
uint16Convert fi object to unsigned 16-bit integer
uint32Stored integer value of fi object as built-in uint32
uint64Convert fi object to unsigned 64-bit integer
uint8Convert fi object to unsigned 8-bit integer
uminusNegate elements of fi object array
unitquantizeQuantize except numbers within eps of +1
unitquantizerConstructor for unitquantizer object
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
wordlengthWord length of quantizer object
xlimSet or query x-axis limits
xorLogical exclusive-OR
ylimSet or query y-axis limits
zerosCreate array of all zeros with fixed-point properties
zlimSet or query z-axis limits
Was this topic helpful?