dsp.ArrayVectorMultiplier

(To be removed) Multiply array by vector along specified dimension

dsp.ArrayVectorMultiplier will be removed in a future release. Use the .* operator instead. For more information, see Compatibility Considerations.

Description

The ArrayVectorMultiplier object multiplies an array by a vector along a specified dimension.

To multiply an array by a vector along a specified:

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

2. Call step to multiply the array according to the properties of dsp.ArrayVectorMultiplier. 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

avm = dsp.ArrayVectorMultiplier returns an array-vector multiplication object, avm, that multiplies an input N-D array by the elements of a vector along the second dimension.

avm = dsp.ArrayVectorMultiplier('PropertyName',PropertyValue,...) returns an array-vector multiplication object, avm, with each property set to the specified value.

Properties

Dimension	Dimension along which to multiply input by vector elements Specify the dimension along which to multiply the input array by the elements of vector as a positive integer. The default is 2.
VectorSource	Source of vector Specify the source of the vector values as one of Input port or Property. The default is Input port.
Vector	Vector to multiply array Specify the vector by which to multiply the array. This property applies when you set the VectorSource property to Property. The default is [0.5 0.25]. This property is tunable.

 Fixed-Point Properties

RoundingMethod	Rounding method for fixed-point operations Specify the rounding method as Ceiling, Convergent, Floor , Nearest, Round, Simplest', Zero. The default is floor.
OverflowAction	Overflow action for fixed-point operations Specify the overflow action as Wrap or Saturate. The default is Wrap.
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).
ProductDataType	Product word and fraction lengths Specify the product fixed-point data type as Full precision , Same as first input, or Custom. The default is Full precision.
CustomProductDataType	Product word and fraction lengths Specify the product fixed-point type as a scaled numerictype (Fixed-Point Designer) object with a Signedness of Auto. This property applies when you set the ProductDataType property to Custom. The default is numerictype([],32,30).
AccumulatorDataType	Accumulator word and fraction lengths Specify the accumulator fixed-point data type as Full precision , Same as product, Same as first input, or 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 when you set the AccumulatorDataType property to Custom. The default is numerictype([],32,30).
OutputDataType	Output word and fraction lengths Specify the output fixed-point data type as Same as product, Same as first input, or Custom. The default is Same as product.
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 when you set the OutputDataType property to Custom. The default is numerictype([],16,15).

Methods

step	Multiply array by vector

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

Examples

Multiply a Matrix by a Vector

Note

If you are using R2016a or an earlier release, replace each call to the object with the equivalent step syntax. For example, obj(x) becomes step(obj,x).

avm = dsp.ArrayVectorMultiplier;
a = ones(2);
x = [2 3]';
y = avm(a, x)

y = 2×2

     2     3
     2     3

Algorithms

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

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

Compatibility Considerations

dsp.ArrayVectorMultiplier System object will be removed

Not recommended starting in R2021a

dsp.ArrayVectorMultiplier System object will be removed in a future release. Use the .* operator instead.

Update Code

This table shows how the System object is typically used and explains how to update existing code to use the .* operator.

Discouraged Usage

Recommended Replacement

Row-wise array multiplication By default, the object computes row-wise array multiplication since the Dimension property of the object is set to 2. avm = dsp.ArrayVectorMultiplier; a = ones(2); x = [2; 3]; y = avm(a, x) y = 2×2 2 3 2 3 Column-wise array multiplication To perform column-wise array multiplication, set the Dimension property to 1 and rerun the object algorithm. release(avm); avm.Dimension = 1; y = avm(a, x) y = 2×2 2 2 3 3 If you are using a release prior to R2016b, replace avm(a,x) with step(avm,a,x).

Row-wise array multiplication y = a .* x' y = 2×2 2 3 2 3 Column-wise array multiplication y = a .* x y = 2×2 2 2 3 3

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).

Introduced in R2012a