polynomialsolversmodule_wrp Module Reference

Wraps the overlap solvers module for calling from other languages. More...

Data Types
type	polynomial_wrp
	A wrapper for the polynomial data type. More...

Functions/Subroutines
pure subroutine, public	constructpolynomial_wrp (ih_this, degree)
	Wrap the empty polynomial constructor. More...
pure subroutine, public	destructpolynomial_wrp (ih_this)
	Destruct a polynomial object. More...
subroutine, public	setcoefficient_wrp (ih_this, degree, coefficient)
	Set coefficient of a polynomial. More...
subroutine, public	hornercompute_wrp (ih_InputMat, ih_OutputMat, ih_polynomial, ih_solver_parameters)
	Compute A Matrix Polynomial Using Horner's Method. More...
subroutine, public	patersonstockmeyercompute_wrp (ih_InputMat, ih_OutputMat, ih_polynomial, ih_solver_parameters)
	Compute A Matrix Polynomial Using Paterson and Stockmeyer's method. More...

Detailed Description

Wraps the overlap solvers module for calling from other languages.

Function/Subroutine Documentation

constructpolynomial_wrp()

pure subroutine, public polynomialsolversmodule_wrp::constructpolynomial_wrp	(	integer(kind=c_int), dimension(size_wrp), intent(inout)	ih_this,
		integer(kind=c_int), intent(in)	degree
	)

Wrap the empty polynomial constructor.

Parameters

[out]	ih_this	handle to the polynomial being created.
[in]	degree	the degree of the polynomial.

destructpolynomial_wrp()

pure subroutine, public polynomialsolversmodule_wrp::destructpolynomial_wrp

(

integer(kind=c_int), dimension(size_wrp), intent(inout)

ih_this

)

Destruct a polynomial object.

Parameters

[in,out]

ih_this

handle to the polynomial to free up.

hornercompute_wrp()

subroutine, public polynomialsolversmodule_wrp::hornercompute_wrp	(	integer(kind=c_int), dimension(size_wrp), intent(in)	ih_InputMat,
		integer(kind=c_int), dimension(size_wrp), intent(inout)	ih_OutputMat,
		integer(kind=c_int), dimension(size_wrp), intent(in)	ih_polynomial,
		integer(kind=c_int), dimension(size_wrp), intent(in)	ih_solver_parameters
	)

Compute A Matrix Polynomial Using Horner's Method.

Parameters

[in]	ih_InputMat	the input matrix
[out]	ih_OutputMat	= poly(InputMat)
[in]	ih_polynomial	polynomial to compute.
[in]	ih_solver_parameters	parameters for the solver (optional).

patersonstockmeyercompute_wrp()

subroutine, public polynomialsolversmodule_wrp::patersonstockmeyercompute_wrp	(	integer(kind=c_int), dimension(size_wrp), intent(in)	ih_InputMat,
		integer(kind=c_int), dimension(size_wrp), intent(inout)	ih_OutputMat,
		integer(kind=c_int), dimension(size_wrp), intent(in)	ih_polynomial,
		integer(kind=c_int), dimension(size_wrp), intent(in)	ih_solver_parameters
	)

Compute A Matrix Polynomial Using Paterson and Stockmeyer's method.

Parameters

[in]	ih_InputMat	the input matrix
[out]	ih_OutputMat	= poly(InputMat)
[in]	ih_polynomial	polynomial to compute.
[in]	ih_solver_parameters	parameters for the solver (optional).

setcoefficient_wrp()

subroutine, public polynomialsolversmodule_wrp::setcoefficient_wrp	(	integer(kind=c_int), dimension(size_wrp), intent(inout)	ih_this,
		integer(kind=c_int), intent(in)	degree,
		real(ntreal), intent(in)	coefficient
	)

Set coefficient of a polynomial.

Parameters

[in,out]	ih_this	handle to the polynomial to set.
[in]	degree	for which to set the coefficient.
[in]	coefficient	value.