cp_linked_list_xc_deriv Module Reference

Data Types
interface	cp_create
interface	cp_dealloc
interface	cp_get_element_at
interface	cp_get_first_el
interface	cp_get_length
interface	cp_get_rest
interface	cp_insert
interface	cp_next
interface	cp_remove_all
interface	cp_remove_el
interface	cp_remove_first_el
interface	cp_set_element_at
type	cp_sll_xc_deriv_p_type
	pointer to a linked list (to make arrays of pointers) More...
type	cp_sll_xc_deriv_type
	represent a single linked list that stores pointers to the elements More...
interface	cp_to_array

Functions/Subroutines
logical function	cp_sll_deriv_less_q (el1, el2)
	private compare function
subroutine, public	cp_sll_xc_deriv_create (sll, first_el, rest)
	allocates and initializes a single linked list
subroutine, public	cp_sll_xc_deriv_dealloc (sll)
	deallocates the singly linked list starting at sll. Does not work if loops are present!
type(xc_derivative_type) function, pointer, public	cp_sll_xc_deriv_get_first_el (sll)
	returns the first element stored in the list
type(cp_sll_xc_deriv_type) function, pointer, public	cp_sll_xc_deriv_get_rest (sll, iter)
	returns the rest of the list
integer function, public	cp_sll_xc_deriv_get_length (sll)
	returns the length of the list
type(xc_derivative_type) function, pointer, public	cp_sll_xc_deriv_get_el_at (sll, index)
	returns the element at the given index
subroutine, public	cp_sll_xc_deriv_set_el_at (sll, index, value)
	sets the element at the given index
logical function, public	cp_sll_xc_deriv_next (iterator, el_att)
	returns true if the actual element is valid (i.e. iterator ont at end) moves the iterator to the next element
subroutine, public	cp_sll_xc_deriv_insert_el (sll, el)
	insert an element at the beginning of the list
subroutine, public	cp_sll_xc_deriv_rm_first_el (sll)
	remove the first element of the linked list
subroutine, public	cp_sll_xc_deriv_insert_el_at (sll, el, index)
	inserts the element at the given index
subroutine, public	cp_sll_xc_deriv_rm_el_at (sll, index)
	removes the element at the given index
subroutine, public	cp_sll_xc_deriv_rm_all_el (sll)
	removes all the elements from the list
type(xc_derivative_p_type) function, dimension(:), pointer, public	cp_sll_xc_deriv_to_array (sll)
	returns a newly allocated array with the same contents as the linked list

Function/Subroutine Documentation

cp_sll_deriv_less_q()

logical function cp_linked_list_xc_deriv::cp_sll_deriv_less_q	(	type(xc_derivative_type), intent(in)	el1,
		type(xc_derivative_type), intent(in)	el2
	)

private compare function

Parameters

el1	...
el2	...

Returns

...

Definition at line 160 of file cp_linked_list_xc_deriv.F.

cp_sll_xc_deriv_create()

subroutine, public cp_linked_list_xc_deriv::cp_sll_xc_deriv_create	(	type(cp_sll_xc_deriv_type), pointer	sll,
		type(xc_derivative_type), optional, pointer	first_el,
		type(cp_sll_xc_deriv_type), optional, pointer	rest
	)

allocates and initializes a single linked list

Parameters

sll	the single linked list to initialize
first_el	the first element of this list
rest	the following elements (if not given: empty)

History

none

Author

Fawzi Mohamed

Definition at line 188 of file cp_linked_list_xc_deriv.F.

Here is the caller graph for this function:

cp_sll_xc_deriv_dealloc()

subroutine, public cp_linked_list_xc_deriv::cp_sll_xc_deriv_dealloc

(

type(cp_sll_xc_deriv_type), pointer

sll

)

deallocates the singly linked list starting at sll. Does not work if loops are present!

Parameters

sll	the list to be deallocated

History

none

Author

Fawzi Mohamed

Note

does not deallocate the elements that are stored in the list check more?

Definition at line 215 of file cp_linked_list_xc_deriv.F.

Here is the caller graph for this function:

cp_sll_xc_deriv_get_first_el()

type(xc_derivative_type) function, pointer, public cp_linked_list_xc_deriv::cp_sll_xc_deriv_get_first_el

(

type(cp_sll_xc_deriv_type), pointer

sll

)

returns the first element stored in the list

Parameters

sll	the single linked list to get the element from

Returns

...

History

none

Author

Fawzi Mohamed

Definition at line 246 of file cp_linked_list_xc_deriv.F.

cp_sll_xc_deriv_get_rest()

type(cp_sll_xc_deriv_type) function, pointer, public cp_linked_list_xc_deriv::cp_sll_xc_deriv_get_rest	(	type(cp_sll_xc_deriv_type), pointer	sll,
		integer, optional	iter
	)

returns the rest of the list

Parameters

sll	the single linked list to get the rest from
iter	how many times the call to rest should be iterated, defaults to 1; -1 means till end of the list.

Returns

...

History

none

Author

Fawzi Mohamed

Note

split the case iter=1 to make it more optimized?

Definition at line 265 of file cp_linked_list_xc_deriv.F.

Here is the caller graph for this function:

cp_sll_xc_deriv_get_length()

integer function, public cp_linked_list_xc_deriv::cp_sll_xc_deriv_get_length

(

type(cp_sll_xc_deriv_type), pointer

sll

)

returns the length of the list

Parameters

sll	the list you want to know the length of

Returns

...

History

none

Author

Fawzi Mohamed

Note

slow (O(n))

Definition at line 307 of file cp_linked_list_xc_deriv.F.

Here is the caller graph for this function:

cp_sll_xc_deriv_get_el_at()

type(xc_derivative_type) function, pointer, public cp_linked_list_xc_deriv::cp_sll_xc_deriv_get_el_at	(	type(cp_sll_xc_deriv_type), pointer	sll,
		integer, intent(in)	index
	)

returns the element at the given index

Parameters

sll	the list you get the element from
index	the position of the element (stating at 1)

Returns

...

History

none

Author

Fawzi Mohamed

Note

slow (O(index))

Definition at line 336 of file cp_linked_list_xc_deriv.F.

cp_sll_xc_deriv_set_el_at()

subroutine, public cp_linked_list_xc_deriv::cp_sll_xc_deriv_set_el_at	(	type(cp_sll_xc_deriv_type), pointer	sll,
		integer, intent(in)	index,
		type(xc_derivative_type), pointer	value
	)

sets the element at the given index

Parameters

sll	the list you get the element from
index	the position of the element (stating at 1) -1 means at the end
value	the new element

History

none

Author

Fawzi Mohamed

Note

slow (O(index))

Definition at line 365 of file cp_linked_list_xc_deriv.F.

cp_sll_xc_deriv_next()

logical function, public cp_linked_list_xc_deriv::cp_sll_xc_deriv_next	(	type(cp_sll_xc_deriv_type), pointer	iterator,
		type(xc_derivative_type), optional, pointer	el_att
	)

returns true if the actual element is valid (i.e. iterator ont at end) moves the iterator to the next element

Parameters

iterator	iterator that moves along the list
el_att	the actual element (valid only if the function returns true)

Returns

...

History

none

Author

Fawzi Mohamed

Definition at line 394 of file cp_linked_list_xc_deriv.F.

Here is the caller graph for this function:

cp_sll_xc_deriv_insert_el()

subroutine, public cp_linked_list_xc_deriv::cp_sll_xc_deriv_insert_el	(	type(cp_sll_xc_deriv_type), pointer	sll,
		type(xc_derivative_type), pointer	el
	)

insert an element at the beginning of the list

Parameters

sll	the single linked list point at the beginning of which you want to add the element
el	the element to add

History

none

Author

Fawzi Mohamed

Note

fast (O(1))

Definition at line 421 of file cp_linked_list_xc_deriv.F.

Here is the caller graph for this function:

cp_sll_xc_deriv_rm_first_el()

subroutine, public cp_linked_list_xc_deriv::cp_sll_xc_deriv_rm_first_el

(

type(cp_sll_xc_deriv_type), pointer

sll

)

remove the first element of the linked list

Parameters

sll	the list whose first element has to be removed

History

none

Author

Fawzi Mohamed

Note

fast (O(1))

Definition at line 443 of file cp_linked_list_xc_deriv.F.

Here is the caller graph for this function:

cp_sll_xc_deriv_insert_el_at()

subroutine, public cp_linked_list_xc_deriv::cp_sll_xc_deriv_insert_el_at	(	type(cp_sll_xc_deriv_type), pointer	sll,
		type(xc_derivative_type), pointer	el,
		integer, intent(in)	index
	)

inserts the element at the given index

Parameters

sll	the list you get the element from
el	the new element
index	the position of the element (stating at 1). If it is -1, it means at end

History

none

Author

Fawzi Mohamed

Note

slow (O(index))

Definition at line 469 of file cp_linked_list_xc_deriv.F.

Here is the call graph for this function:

cp_sll_xc_deriv_rm_el_at()

subroutine, public cp_linked_list_xc_deriv::cp_sll_xc_deriv_rm_el_at	(	type(cp_sll_xc_deriv_type), pointer	sll,
		integer, intent(in)	index
	)

removes the element at the given index

Parameters

sll	the list you get the element from
index	the position of the element (stating at 1)

History

none

Author

Fawzi Mohamed

Note

slow (O(index))

Definition at line 499 of file cp_linked_list_xc_deriv.F.

cp_sll_xc_deriv_rm_all_el()

subroutine, public cp_linked_list_xc_deriv::cp_sll_xc_deriv_rm_all_el

(

type(cp_sll_xc_deriv_type), pointer

sll

)

removes all the elements from the list

Parameters

sll	the list that should be removed

History

none

Author

Fawzi Mohamed

Note

check more?

Definition at line 527 of file cp_linked_list_xc_deriv.F.

Here is the caller graph for this function:

cp_sll_xc_deriv_to_array()

type(xc_derivative_p_type) function, dimension(:), pointer, public cp_linked_list_xc_deriv::cp_sll_xc_deriv_to_array

(

type(cp_sll_xc_deriv_type), pointer

sll

)

returns a newly allocated array with the same contents as the linked list

Parameters

sll	the list to transform in array

Returns

...

History

07.2002 created [fawzi]

Author

Fawzi Mohamed

Definition at line 551 of file cp_linked_list_xc_deriv.F.