power (DataMatrix)

Array power DataMatrix objects

Syntax

DMObjNew = power(DMObj1, DMObj2)
DMObjNew = DMObj1 .^ DMObj2
DMObjNew = power(DMObj1, B)
DMObjNew = DMObj1 .^ B
DMObjNew = power(B, DMObj1)
DMObjNew = B .^ DMObj1

Input Arguments

DMObj1, DMObj2DataMatrix objects, such as created by DataMatrix (object constructor).
BMATLAB® numeric or logical array.

Output Arguments

DMObjNewDataMatrix object created by array power.

Description

DMObjNew = power(DMObj1, DMObj2) or the equivalent DMObjNew = DMObj1 .^ DMObj2 performs an element-by-element power of the DataMatrix objects DMObj1 and DMObj2 and places the results in DMObjNew, another DataMatrix object. In other words, power raises each element in DMObj1 by the corresponding element in DMObj2. DMObj1 and DMObj2 must have the same size (number of rows and columns), unless one is a scalar (1-by-1 DataMatrix object). The size (number of rows and columns), row names, and column names for DMObjNew are the same as DMObj1, unless DMObj1 is a scalar; then they are the same as DMObj2.

DMObjNew = power(DMObj1, B) or the equivalent DMObjNew = DMObj1 .^ B performs an element-by-element power of the DataMatrix object DMObj1 and B, a numeric or logical array, and places the results in DMObjNew, another DataMatrix object. In other words, power raises each element in DMObj1 by the corresponding element in B. DMObj1 and B must have the same size (number of rows and columns), unless B is a scalar. The size (number of rows and columns), row names, and column names for DMObjNew are the same as DMObj1.

DMObjNew = power(B, DMObj1) or the equivalent DMObjNew = B .^ DMObj1 performs an element-by-element power of B, a numeric or logical array, and the DataMatrix object DMObj1, and places the results in DMObjNew, another DataMatrix object. In other words, power raises each element in B by the corresponding element in DMObj1.DMObj1 and B must have the same size (number of rows and columns), unless B is a scalar. The size (number of rows and columns), row names, and column names for DMObjNew are the same as DMObj1.

    Note:   Arithmetic operations between a scalar DataMatrix object and a nonscalar array are not supported.

MATLAB calls DMObjNew = power(X, Y) for the syntax DMObjNew = X .^ Y when X or Y is a DataMatrix object.

See Also

|

Was this topic helpful?