Computes matrix powers, with optional applicationspecific callbacks. Accommodates (external) parallel multiplication mechanisms.
1 
m 
input matrix. 
k 
desired power. If NULL, it is expected that the
initialization portion of the user's callback function will set

squaring 
if TRUE, saves time by first squaring 
genmulcmd 
function to generate multiplication commands, in
quoted string form. For the ordinary R 
dup 
function to make a deep copy of a matrix. 
callback 
applicationspecific callback function. 
... 
applicationspecific arguments 
Multiplication is iterated until the desired power k
is
reached, with these exceptions: (a) If squaring
is TRUE,
k
may be exceeded. (b) The callback function can set stop
in ev
, halting iterations; this is useful, for instance, if some
convergence criterion has been reached.
One key advantage of using matpow
rather than direct iteration
is that parallel computation can be accommodated, by specifying
genmulcmd
. (The word "accommodated" here means the user must
have available a mechanism for parallel computation; matpow
itself contains no parallel code.)
For instance, if one is using GPU with gputools
, one sets
genmulcmd
to genmulcmd.gputools
, which calls
gpuMatMult()
instead of the usual %*%
. So, one can
switch from serial to parallel by merely changing this one argument.
If genmulcmd
is not specified, the code attempts to sense the
proper function by inspecting class(m)
, in the cases of
classes "matrix"
and "big.matrix"
.
Of course, if the user's R is configured to use a parallel BLAS, such
as OpenBLAS, this is automatically handled via the ordinary R
"matrix"
class.
Another important advantage of matpow
is the ability to write
a callback function, which enables much flexibility. The callback,
if present, is called by matpow
after each iteration, allowing
applicationspecific operations to be applied. For instance,
cgraph
determines the connectivity of a graph, by
checking whether the current power has all of its entries nonzero.
The call form is callbackname(ev,init,...)
where ev
is
the R environment described above, and init
must be set to
TRUE on the first call, and FALSE afterward.
Since some types of matrix multiplication do not allow the product to
be in the same physical location as either multiplicand, a
"red and black" approach is taken to the iteration process: Storage
space for powers in ev
alternatives between prod1
and
prod2
, for oddnumbered and evennumbered iterations,
respectively.
An R environment ev
, including the following components:
prod1 
matrix, the final power. 
stop 
boolean value, indicating whether the iterations were stopped before the final power was to be computed. 
i 
number of the last iteration performed. 
Applicationspecific data, maintained by the callback function, can be stored here as well.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 
Questions? Problems? Suggestions? Tweet to @rdrrHQ or email at ian@mutexlabs.com.
Please suggest features or report bugs with the GitHub issue tracker.
All documentation is copyright its authors; we didn't write any of that.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.