dsp.ArrayVectorMultiplier System object

Package: dsp

Multiply array by vector along specified dimension

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.

Construction

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

H = dsp.ArrayVectorMultiplier('PropertyName',PropertyValue,...) returns an array-vector multiplication object, H, 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

Methods

cloneCreate array-vector multiplication object with same property values
getNumInputsNumber of expected inputs to step method
getNumOutputsNumber of outputs of step method
isLockedLocked status for input attributes and nontunable properties
releaseAllow property value and input characteristics changes
stepMultiply array by vector

Examples

Multiply a matrix by a vector:

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

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.

Was this topic helpful?