add

Add two arrays using fimath object

Syntax

c = add(F,a,b)

Description

c = add(F,a,b) adds input arrays a and b using fimath object F. This is helpful in cases when you want to override the fimath objects of a and b, or if the fimath properties associated with a and b are different. The output c has no local fimath.

Examples

Add Two Fixed-Point Numbers

In this example, c is the 32-bit sum of a and b with fraction length 16.

a = fi(pi);
b = fi(exp(1));
F = fimath('SumMode','SpecifyPrecision',...
  'SumWordLength',32,'SumFractionLength',16);
c = add(F,a,b)

c = 
    5.8599

          DataTypeMode: Fixed-point: binary point scaling
            Signedness: Signed
            WordLength: 32
        FractionLength: 16

Input Arguments

F — fimath

fimath object

fimath object to use for addition.

a,b — Operands

scalars | vectors | matrices | multidimensional arrays

Operands, specified as scalars, vectors, matrices, or multidimensional arrays.

a and b must have the same dimensions unless one is a scalar. If either a or b is scalar, then c has the dimensions of the nonscalar object.

If a or b is a fi object, then both a and b must be fi objects.

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | fi
Complex Number Support: Yes

Algorithms

When you use add, the fimath properties of a and b are not modified, and the output fi object, c, has no local fimath.

c = add(F,a,b)

is equivalent to

c = removefimath(setfimath(a,F) + setfimath(b,F))

Extended Capabilities

C/C++ Code Generation

Generate C and C++ code using MATLAB® Coder™.

Usage notes and limitations:

• The syntax F.add(a,b) is not supported. You must use the syntax add(F,a,b).

HDL Code Generation
Generate VHDL, Verilog and SystemVerilog code for FPGA and ASIC designs using HDL Coder™.

Version History

Introduced before R2006a

R2024a: Support for floating-point and built-in integer data types

The add function now supports inputs that have floating-point or built-in integer data types.