dsp.ArrayVectorDivider System object

Package: dsp

Divide array by vector along specified dimension

Description

The ArrayVectorDivider object divides an array by a vector along a specified dimension.

To divide an array by a vector along a specified dimension:

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

  2. Call step to divide the array according to the properties of dsp.ArrayVectorDivider. The behavior of step is specific to each object in the toolbox.

Construction

H = dsp.ArrayVectorDivider returns an array-vector division object, H, that divides an input array by the elements of a vector along the first dimension of the array.

H = dsp.ArrayVectorDivider('PropertyName',PropertyValue,...) returns an array-vector division object, H, with each property set to the specified value.

Properties

Dimension

Dimension along which to divide input by vector elements

Specify the dimension along which to divide the input array by the elements of a vector as a positive integer. 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 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 division 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
stepDivide array by vector

Examples

Divide a matrix by a vector.

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

Algorithms

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

The array-vector division object does not have Minimum or Maximum options for data output.
Was this topic helpful?