SearchArray - Maple Help
For the best experience, we recommend viewing online help using Google Chrome or Microsoft Edge.

Online Help

All Products    Maple    MapleSim


ArrayTools

  

SearchArray

  

return the indices of nonzero elements of the given Array

 

Calling Sequence

Parameters

Options

Description

Examples

Compatibility

Calling Sequence

SearchArray(A)

SearchArray(A, n)

SearchArray(A, output = outspec)

ind := SearchArray(A, ...);

row, col := SearchArray(A, ...);

row, col, val := SearchArray(A, ...);

Parameters

A

-

the given Array

n

-

(optional) number of indices returned

ind

-

the Array stores returned indices

row

-

the Array stores the row numbers of returned indices

col

-

the Array stores the column numbers of returned indices

val

-

the Array stores values of found nonzero numbers

Options

• 

location=name

  

one of first or last controls whether the first n or last n entries is returned when n is given. first is the default.

• 

output=name

  

one of index, rowcol, or rowcolval to force the desired output specification without using an assignment.

Description

• 

The SearchArray(A) function returns a vector of numbers such that each element in the returned vector corresponds to an index of a nonzero entry in A.

• 

The SearchArray(A, n) and SearchArray(A, n, location = first) calling sequences return a vector of the first n indices corresponding to nonzero entries in A.

• 

The SearchArray(A, n, location = last) calling sequence returns a vector of the last n indices corresponding to nonzero entries in A.

• 

The output specification of SearchArray, if it is on the right-hand side of an assignment, is controlled by the number of targets on the left-hand side otherwise it is controlled by the output option.

• 

The row, col := SearchArray(A, ...) or SearchArray(A, output=rowcol) calling sequences return two Vectors corresponding to the paired row and column indices for nonzero entries in A.

• 

The row, col, val := SearchArray(A, ...) or SearchArray(A, output=rowcolval) calling sequences return two Vectors corresponding to the paired row and column indices for nonzero entries in A and returns in the third Vector the value of the array A at each of these positions.

Examples

withArrayTools:

AArray0,3,4,0,6,8,9

A0340689

(1)

SearchArrayA

23567

(2)

SearchArrayA,4,location=first

2356

(3)

SearchArrayA,4,location=last

3567

(4)

BArray1,2,0,9,7,0,6,4

B120970−64

(5)

row,colSearchArrayB

row,col134124,111222

(6)

SearchArrayB,output=rowcol

134124,111222

(7)

row,col,valSearchArrayB

row,col,val134124,111222,17−6294

(8)

row,col,valSearchArrayB,4

row,col,val1341,1112,17−62

(9)

SearchArrayB,4,output=rowcolval

1341,1112,17−62

(10)

Compatibility

• 

The output option was introduced in Maple 2024.

• 

For more information on Maple 2024 changes, see Updates in Maple 2024.

See Also

ArrayTools

ArrayTools[RandomArray]

ArrayTools[RegularArray]

ArrayTools[Size]

rtable_indexing