Functions
int	oski_MatMultAndMatTransMult (const oski_matrix_t A_tunable, oski_value_t alpha, const oski_vecview_t x_view, oski_value_t beta, oski_vecview_t y_view, oski_matop_t opA, oski_value_t omega, const oski_vecview_t w_view, oski_value_t zeta, oski_vecview_t z_view)
	Computes $y \leftarrow \alpha\cdot Ax + \beta\cdot y$ and $z \leftarrow \omega\cdot\mathrm{op}(A)x + \zeta\cdot z$ , where $\mathrm{op}(A) \in \{A, A^T, A^H\}$ .
int	oski_MatTransMatMult (const oski_matrix_t A_tunable, oski_ataop_t op, oski_value_t alpha, const oski_vecview_t x_view, oski_value_t beta, oski_vecview_t y_view, oski_vecview_t t_view)
	Computes $y \leftarrow \alpha\cdot\mathrm{op}(A)x + \beta\cdot y$ , where $\mathrm{op}(A) \in \{AA^T, A^TA, AA^H, A^HA\}$ .
int	oski_MatMult (const oski_matrix_t A_tunable, oski_matop_t opA, oski_value_t alpha, const oski_vecview_t x_view, oski_value_t beta, oski_vecview_t y_view)
	Computes $y \leftarrow \alpha\cdot\mathrm{op}(A)x + \beta\cdot y$ , where $\mathrm{op}(A) \in \{A, A^T, A^H\}$ .
int	oski_MatPowMult (const oski_matrix_t A_tunable, oski_matop_t opA, int power, oski_value_t alpha, const oski_vecview_t x_view, oski_value_t beta, oski_vecview_t y_view, oski_vecview_t T_view)
	Computes a power of a matrix times a vector, or $y \leftarrow \alpha\cdot\mathrm{op}(A)^\rho x + \beta\cdot y$ .
int	oski_MatTrisolve (const oski_matrix_t T_tunable, oski_matop_t opT, oski_value_t alpha, oski_vecview_t x_view)
	Computes $x \leftarrow \alpha\cdot\mathrm{op}(T^{-1})x$ , where is a triangular matrix.

Function Documentation

int oski_MatMult	(	const oski_matrix_t	A_tunable,
		oski_matop_t	opA,
		oski_value_t	alpha,
		const oski_vecview_t	x_view,
		oski_value_t	beta,
		const oski_vecview_t	y_view
	)

Computes $y \leftarrow \alpha\cdot\mathrm{op}(A)x + \beta\cdot y$ , where $\mathrm{op}(A) \in \{A, A^T, A^H\}$ .

Parameters:

[in]	A_tunable	Sparse matrix object, .
[in]	opA	Specifies the transpose operation, .
[in]	alpha	Scalar multiplier, $\alpha$ .
[in]	x_view	Vector view object, .
[in]	beta	Scalar multiplier, $\beta$ .
[in,out]	y_view	Vector view object, .

Returns:: 0 on success, or an error code.

References ERR_BAD_VECVIEW, ERR_NOT_IMPLEMENTED, oski_matstruct_t::input_mat, INVALID_ID, MACRO_TO_STRING, MatReprMult, OSKI_ERR, OSKI_ERR_BAD_VEC, OSKI_ERR_NOT_IMPLEMENTED, OSKI_KERNEL_MatMult, OSKI_MATTYPEID_METHOD, oski_ReadElapsedTime(), oski_RecordCall, oski_RestartTimer(), oski_StopTimer(), oski_matstruct_t::props, oski_matspecific_t::repr, oski_matstruct_t::timer, oski_matstruct_t::trace, oski_matstruct_t::tuned_mat, and oski_matspecific_t::type_id.

int oski_MatMultAndMatTransMult	(	const oski_matrix_t	A_tunable,
		oski_value_t	alpha,
		const oski_vecview_t	x_view,
		oski_value_t	beta,
		oski_vecview_t	y_view,
		oski_matop_t	op,
		oski_value_t	omega,
		const oski_vecview_t	w_view,
		oski_value_t	zeta,
		oski_vecview_t	z_view
	)

Computes $y \leftarrow \alpha\cdot Ax + \beta\cdot y$ and $z \leftarrow \omega\cdot\mathrm{op}(A)x + \zeta\cdot z$ , where $\mathrm{op}(A) \in \{A, A^T, A^H\}$ .

Parameters:

[in]	A_tunable	Sparse matrix object, .
[in]	op	Specifies the transpose operation, $\mathrm{op}(A)$ .
[in]	alpha	Scalar multiplier, $\alpha$ .
[in]	x_view	Vector view object, .
[in]	beta	Scalar multiplier, $\beta$ .
[in]	y_view	Vector view object, .
[in]	omega	Scalar multiplier, $\omega$ .
[in]	w_view	Vector view object, .
[in]	zeta	Scalar multiplier, $\zeta$ .
[in]	z_view	Vector view object, .

Returns:: 0 on success, or an error code.

References ERR_BAD_VECVIEW, INVALID_ID, MatMultAndMatTransMultDefault, OSKI_ERR, OSKI_ERR_BAD_VEC, OSKI_KERNEL_MatMultAndMatTransMult, OSKI_MATTYPEID_METHOD, oski_ReadElapsedTime(), oski_RecordCall, oski_matstruct_t::props, oski_matspecific_t::repr, oski_matstruct_t::timer, oski_matstruct_t::trace, oski_matstruct_t::tuned_mat, and oski_matspecific_t::type_id.

int oski_MatPowMult	(	const oski_matrix_t	A_tunable,
		oski_matop_t	opA,
		int	power,
		oski_value_t	alpha,
		const oski_vecview_t	x_view,
		oski_value_t	beta,
		oski_vecview_t	y_view,
		oski_vecview_t	T_view
	)

Computes a power of a matrix times a vector, or $y \leftarrow \alpha\cdot\mathrm{op}(A)^\rho x + \beta\cdot y$ .

Parameters:

[in]	A_tunable	The $m\times n$ matrix object .
[in]	opA	Transpose option, .
[in]	power	Non-negative matrix power .
[in]	alpha	Scalar multiplier $\alpha$ .
[in]	x_view	Single vector object .
[in]	beta	Scalar multiplier $\alpha$ .
[in,out]	y_view	Single vector object .
[in,out]	T_view	Multivector object consisting of $\max\{k-1,0\}$ column vectors in which to store intermediate results.

Returns:: Computes and returns 0 on success, or an error code otherwise.

References DefaultMatPowMult(), ERR_BAD_VECVIEW, oski_matstruct_t::input_mat, INVALID_ID, MACRO_TO_STRING, OSKI_ERR, OSKI_ERR_BAD_VEC, OSKI_KERNEL_MatPowMult, OSKI_MATTYPEID_METHOD, oski_ReadElapsedTime(), oski_RecordCall, oski_RestartTimer(), oski_StopTimer(), oski_matstruct_t::props, oski_matspecific_t::repr, oski_matstruct_t::timer, oski_matstruct_t::trace, oski_matstruct_t::tuned_mat, and oski_matspecific_t::type_id.

int oski_MatTransMatMult	(	const oski_matrix_t	A_tunable,
		oski_ataop_t	op,
		oski_value_t	alpha,
		const oski_vecview_t	x_view,
		oski_value_t	beta,
		oski_vecview_t	y_view,
		oski_vecview_t	t_view
	)

Computes $y \leftarrow \alpha\cdot\mathrm{op}(A)x + \beta\cdot y$ , where $\mathrm{op}(A) \in \{AA^T, A^TA, AA^H, A^HA\}$ .

Parameters:

[in]	A_tunable	Sparse matrix object, .
[in]	op	Specifies the transpose operation, .
[in]	alpha	Scalar multiplier, $\alpha$ .
[in]	x_view	Vector view object, .
[in]	beta	Scalar multiplier, $\beta$ .
[in]	y_view	Vector view object, .
[in]	t_view	Vector view object, . The caller may set t_view == INVALID_VEC if no intermediate result is desired.

Returns:: 0 on success, or an error code.

References ERR_BAD_VECVIEW, ERR_NOT_IMPLEMENTED, INVALID_ID, MACRO_TO_STRING, MatTransMatMultDefault, OSKI_ERR, OSKI_ERR_BAD_VEC, OSKI_KERNEL_MatTransMatMult, OSKI_MATTYPEID_METHOD, oski_ReadElapsedTime(), oski_RecordCall, oski_RestartTimer(), oski_StopTimer(), oski_matstruct_t::props, oski_matspecific_t::repr, oski_matstruct_t::timer, oski_matstruct_t::trace, oski_matstruct_t::tuned_mat, and oski_matspecific_t::type_id.

int oski_MatTrisolve	(	const oski_matrix_t	T,
		oski_matop_t	opT,
		oski_value_t	alpha,
		oski_vecview_t	x
	)

Computes $x \leftarrow \alpha\cdot\mathrm{op}(T^{-1})x$ , where $T$ is a triangular matrix.

Parameters:

[in]	T_tunable	Triangular sparse matrix object, .
[in]	opT	Specifies the transpose operation, .
[in]	alpha	Scalar multiplier, $\alpha$ .
[in,out]	x_view	Vector view object, .

Returns:: 0 on success, or an error code.

Todo:: For efficiency, this routine does not attempt to pre-scan the matrix data structure and ensure there are no zero diagonals. At least for CSR and CSC input matrices, we should add some kind of check somewhere (e.g., at matrix handle creation time). A similar to-do appears elsewhere in this source.

References ERR_BAD_VECVIEW, ERR_NOT_IMPLEMENTED, oski_matstruct_t::input_mat, INVALID_ID, MACRO_TO_STRING, OSKI_ERR, OSKI_ERR_BAD_VEC, OSKI_ERR_NOT_IMPLEMENTED, OSKI_KERNEL_MatTrisolve, OSKI_MATTYPEID_METHOD, oski_ReadElapsedTime(), oski_RecordCall, oski_RestartTimer(), oski_StopTimer(), oski_matstruct_t::props, oski_matspecific_t::repr, oski_matstruct_t::timer, oski_matstruct_t::trace, oski_matstruct_t::tuned_mat, and oski_matspecific_t::type_id.

Functions

Function Documentation