dsp.ArrayVectorAdder

Add array to vector along specified dimension

Description

The ArrayVectorAdder object adds an N-D array to a vector along a specified dimension. The length of the vector must equal the size of the N-D array along the specified dimension.

To add an N-D array to a vector along a specified dimension:

1. Define and set up your array-vector addition object. See Construction.

2. Call step to add the N-D array according to the properties of dsp.ArrayVectorAdder. The behavior of step is specific to each object in the toolbox.

Note

Starting in R2016b, instead of using the step method to perform the operation defined by the System object™, you can call the object with arguments, as if it were a function. For example, y = step(obj,x) and y = obj(x) perform equivalent operations.

Construction

ava = dsp.ArrayVectorAdder returns an array-vector addition object, ava, that adds a vector to an N-D array along the first dimension.

ava = dsp.ArrayVectorAdder('PropertyName',PropertyValue, ...) returns an array-vector addition object, ava, with each property set to the specified value.

Properties

Dimension	Dimension along which to add vector elements to input Specify the dimension along which to add the input array to the elements of the vector as a positive integer. The length of the vector must match the size of the N-D array along the specified dimension. The default is 1.
VectorSource	Source of vector Specify the source of the vector values as |Input port | Property |. The default is Input port.
Vector	Vector values Specify the vector values. This property applies only when you set the VectorSource property to Property. The default is [0.5 0.25]. This property is tunable.

 Fixed-Point Properties

FullPrecisionOverride

Full precision override for fixed-point arithmetic Specify whether to use full precision rules. If you set FullPrecisionOverride to true, which is the default, the object computes all internal arithmetic and output data types using full precision rules. These rules provide the most accurate fixed-point numerics. It also turns off the display of other fixed-point properties because they do not apply individually. These rules guarantee that no quantization occurs within the object. Bits are added, as needed, to ensure that no roundoff or overflow occurs. If you set FullPrecisionOverride to false, fixed-point data types are controlled through individual fixed-point property settings. For more information, see Full Precision for Fixed-Point System Objects.

RoundingMethod	Rounding method for fixed-point operations Specify the rounding method as | Ceiling | Convergent | Floor | Nearest | Round | Simplest | Zero |. The default is Floor. This property applies only if the object is not in full precision mode.
OverflowAction	Overflow action for fixed-point operations Specify the overflow action as | Wrap | Saturate |. The default is Wrap. This property applies only if the object is not in full precision mode.
VectorDataType	Vector word and fraction lengths Specify the vector fixed-point data type as | Same word length as input | Custom |. This property applies when you set the VectorSource property to Property. The default is Same word length as input.
CustomVectorDataType	Vector word and fraction lengths Specify the vector fixed-point type as a numerictype (Fixed-Point Designer) object with a Signedness of Auto. This property applies when you set the VectorSource property to Property and the VectorDataType property to Custom. The default is numerictype([],16,15).
AccumulatorDataType	Accumulator word and fraction lengths Specify the accumulator fixed-point data type as | Full precision | Same as first input | Custom |. The default is Full precision.
CustomAccumulatorDataType	Accumulator word and fraction lengths Specify the accumulator fixed-point type as a scaled numerictype (Fixed-Point Designer) object with a Signedness of Auto. This property applies only when the AccumulatorDataType property is Custom. The default is numerictype([],32,30).
OutputDataType	Output word and fraction lengths Specify the output fixed-point data type as | Same as accumulator | Same as first input | Custom |.
CustomOutputDataType	Output word and fraction lengths Specify the output fixed-point type as a scaled numerictype (Fixed-Point Designer) object with a Signedness of Auto. This property applies only when the OutputDataType property is Custom. The default is numerictype([],16,15).

Methods

step	Add vector to N-D array

Common to All System Objects
release	Allow System object property value changes

Examples

Add a Vector To a Matrix

Note: This example runs only in R2016b or later. If you are using an earlier release, replace each call to the function with the equivalent step syntax. For example, myObject(x) becomes step(myObject,x).

Add a 2-by-1 vector to a 2-by-2 matrix along the first dimension of the array.

ava = dsp.ArrayVectorAdder;
a = ones(2);
x = [1 2]';
y = ava(a, x);

Algorithms

This object implements the algorithm, inputs, and outputs described on the Array-Vector Add block reference page. The object properties correspond to the block parameters, except:

The array-vector addition object does not have Minimum or Maximum options for data output.

Extended Capabilities

C/C++ Code Generation

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

Usage notes and limitations:

See System Objects in MATLAB Code Generation (MATLAB Coder).