prg_extras_mod Module Reference

Extra routines. More...

Data Types
interface	prg_memory_consumption
interface	to_string

Functions/Subroutines
character(len=:) function, allocatable	to_string_integer (i)
	Convert integer to string. More...
character(len=:) function, allocatable	to_string_long_long (i)
	Convert integer to string. More...
character(len=:) function, allocatable	to_string_double (x)
	Convert double to string. More...
subroutine, public	prg_print_matrix (matname, amat, i1, i2, j1, j2)
	To write a dense matrix to screen. More...
real(dp) function, public	mls ()
	To get the actual time in milliseconds. More...
subroutine, public	prg_delta (x, s, nn, dta)
	Delta function ||X^tSX - I||. More...
subroutine, public	prg_get_mem (procname, tag)
	Get proc memory. More...
subroutine	prg_twonorm (a, nn, norm2)
	Gets the norm2 of a square matrix. More...
real(dp) function, public	prg_norm2 (a)
	Gets the norm2 of a vector. More...

Variables
integer, parameter	dp = kind(1.0d0)

Detailed Description

Extra routines.

A module to add any extra routine considered necessary but which is NOT essential for any other PROGRESS routine.

Function/Subroutine Documentation

mls()

real(dp) function, public prg_extras_mod::mls

To get the actual time in milliseconds.

Parameters

mls	Output value with the machine time in milliseconds.

Definition at line 139 of file prg_extras_mod.F90.

prg_delta()

subroutine, public prg_extras_mod::prg_delta	(	real(dp), dimension(nn,nn)	x,
		real(dp), dimension(nn,nn)	s,
		integer	nn,
		real(dp)	dta
	)

Delta function ||X^tSX - I||.

Parameters

x	input matrix.
s	overlap matrix.
dta	Delta output value.

Definition at line 155 of file prg_extras_mod.F90.

prg_get_mem()

subroutine, public prg_extras_mod::prg_get_mem	(	character(*), intent(in)	procname,
		character(*), intent(in)	tag
	)

Get proc memory.

Parameters

procname	Process name to get the mem usage.
tag	Tag to pprint the processor mem usage.

Definition at line 191 of file prg_extras_mod.F90.

prg_norm2()

real(dp) function, public prg_extras_mod::prg_norm2

(

real(dp), dimension(:), intent(in)

a

)

Gets the norm2 of a vector.

Parameters

a

Vector.

Definition at line 240 of file prg_extras_mod.F90.

prg_print_matrix()

subroutine, public prg_extras_mod::prg_print_matrix	(	character(len=*)	matname,
		real(dp), dimension(:,:), intent(in)	amat,
		integer, intent(in)	i1,
		integer, intent(in)	i2,
		integer, intent(in)	j1,
		integer, intent(in)	j2
	)

To write a dense matrix to screen.

Parameters

matname	Matrix name.
amat	Matrix to be printed.
i1	Print from row i1.
i2	Print up to from row i2.
j1	Print from column j1.
j2	Print up to column j2.

Definition at line 100 of file prg_extras_mod.F90.

prg_twonorm()

subroutine prg_extras_mod::prg_twonorm ( real(dp), dimension(nn,nn)  a, integer  nn, real(dp)  norm2  )

private

Gets the norm2 of a square matrix.

Parameters

a	Square matrix.
nn	Matrix size.
norm2	Two-norm of matrix a.

Definition at line 215 of file prg_extras_mod.F90.

to_string_double()

character(len=:) function, allocatable prg_extras_mod::to_string_double ( double precision, intent(in)  x )

private

Convert double to string.

Parameters

x	The double

Returns

The string

Definition at line 80 of file prg_extras_mod.F90.

to_string_integer()

character(len=:) function, allocatable prg_extras_mod::to_string_integer ( integer, intent(in)  i )

private

Convert integer to string.

Parameters

i	The integer

Returns

The string

Definition at line 46 of file prg_extras_mod.F90.

to_string_long_long()

character(len=:) function, allocatable prg_extras_mod::to_string_long_long ( integer(kind=c_long_long), intent(in)  i )

private

Convert integer to string.

Parameters

i	The integer

Returns

The string

Definition at line 62 of file prg_extras_mod.F90.

Variable Documentation

dp

integer, parameter prg_extras_mod::dp = kind(1.0d0)

private

Definition at line 31 of file prg_extras_mod.F90.