Prev

Next

Index-> contents reference index search external

Up-> CppAD speed speed_utility mat_sum_sq

CppAD-> Install Introduction AD ADFun preprocessor multi_thread utility ipopt_solve Example speed Appendix

speed-> speed_main speed_utility speed_double speed_adolc speed_cppad speed_fadbad speed_sacado

speed_utility-> det_by_lu det_of_minor det_by_minor det_33 det_grad_33 mat_sum_sq ode_evaluate sparse_jac_fun sparse_hes_fun uniform_01

mat_sum_sq-> mat_sum_sq.cpp mat_sum_sq.hpp

Headings-> Syntax Purpose Inclusion n x y z Vector Example Source Code

@(@\newcommand{\W}[1]{ \; #1 \; } \newcommand{\R}[1]{ {\rm #1} } \newcommand{\B}[1]{ {\bf #1} } \newcommand{\D}[2]{ \frac{\partial #1}{\partial #2} } \newcommand{\DD}[3]{ \frac{\partial^2 #1}{\partial #2 \partial #3} } \newcommand{\Dpow}[2]{ \frac{\partial^{#1}}{\partial {#2}^{#1}} } \newcommand{\dpow}[2]{ \frac{ {\rm d}^{#1}}{{\rm d}\, {#2}^{#1}} }@)@ Sum Elements of a Matrix Times Itself
Syntax
# include <cppad/speed/mat_sum_sq.hpp>
mat_sum_sq(n, x, y, z)

Purpose
This routine is intended for use with the matrix multiply speed tests; to be specific, it computes @[@ \begin{array}{rcl} y_{i,j} & = & \sum_{k=0}^{n-1} x_{i,k} x_{k,j} \\ z_0 & = & \sum_{i=0}^{n-1} \sum_{j=0}^{n-1} y_{i,j} \end{array} @]@ see link_mat_mul .

Inclusion
The template function mat_sum_sq is defined in the CppAD namespace by including the file cppad/speed/mat_sum_sq.hpp (relative to the CppAD distribution directory).

n
This argument has prototype
     size_t n
It specifies the size of the matrices.

x
The argument x has prototype
     const Vector &x
and x.size() == n * n . It contains the elements of @(@ x @)@ in row major order; i.e., @[@ x_{i,j} = x [ i * n + j ] @]@

y
The argument y has prototype
     Vector& y
and y.size() == n * n . The input value of its elements does not matter. Upon return, @[@ \begin{array}{rcl} y_{i,j} & = & \sum_{k=0}^{n-1} x_{i,k} x_{k,j} \\ y[ i * n + j ] & = & y_{i,j} \end{array} @]@

z
The argument d has prototype
     Vector& z
. The input value of its element does not matter. Upon return @[@ \begin{array}{rcl} z_0 & = & \sum_{i=0}^{n-1} \sum_{j=0}^n y_{i,j} \\ z[0] & = & z_0 \end{array} @]@

Vector
The type Vector is any SimpleVector , or it can be a raw pointer to the vector elements. The element type must support addition, multiplication, and assignment to both its own type and to a double value.

Example
The file mat_sum_sq.cpp contains an example and test of mat_sum_sq.hpp. It returns true if it succeeds and false otherwise.

Source Code
The file mat_sum_sq.hpp contains the source for this template function.

---

Input File: cppad/speed/mat_sum_sq.hpp